随着前端开发越来越流行，越来越多的开发者开始接触后端开发。但是，很多人发现创建 API 文档是一件比较麻烦的事情。本篇文章将会介绍如何使用 Fastify 和 Swagger 快速创建 API 文档。
Fastify 简介
Fastify 是一个高效、低开销的 Web 框架，专门为 Web 开发而设计。它通过使用 Node.js 的异步流程和快速的 JSON 序列化，提供了非常快的性能。它还提供了灵活的插件系统，让你可以以更容易的方式扩展应用程序。
Swagger 简介
Swagger 是一个用于构建、设计和测试 API 的强大工具。它可以自动生成 API 文档，让 API 的使用变得更加简单和易于理解。Swagger 还为 API 的测试和部署提供了很多支持。
安装 Fastify 和 Swagger
使用以下命令在你的项目中安装 Fastify 和 Swagger：
--- ------- ------- ----------
创建 Fastify 应用
接下来，让我们来创建一个简单的 Fastify 应用。在你的项目根目录下创建一个名为 server.js 的文件，并输入以下代码：
----- ------- - -------------------- ---------------- ----- --------- ------ -- - ------ - ------ ------- - -- -------------------- --------------- -- ------------------- --------- -- ------------- ------------ -- -------------------
上述代码创建了一个简单的 / 路由，它会返回一个包含 { hello: 'world' } 的 JSON 响应。你可以通过使用以下命令启动此应用：
---- ---------
添加 Swagger
接下来，我们将为我们的 Fastify 应用添加 Swagger。在我们的 server.js 文件中，添加以下代码：
----- -------------- - --------------------------
-------------------------------- -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- ---------------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
--上述代码将 fastify-swagger 插件添加到我们的应用中，并为我们的 API 添加了几个 Swagger 相关信息。我们的 API 文档将通过 http://localhost:3000/documentation 访问。
现在，我们可以为 API 中的每个路由添加 Swagger 文档。在我们的 / 路由后添加以下代码：
------- -
--------- -
---- -
----- ---------
----------- -
------ -
----- --------
-
-
-
-
-上述代码创建了一个包含 / 路由返回值的 Swagger 文档。
---------------- -
------- -
--------- -
---- -
----- ---------
----------- -
------ -
----- --------
-
-
-
-
-
-- ----- --------- ------ -- -
------ - ------ ------- -
--查看 Swagger 文档
现在我们已经添加了 Swagger 文档，我们可以通过浏览器访问 http://localhost:3000/documentation 来查看它们。如果你已经成功地完成了上述步骤，你应该可以看到一个 Swagger UI 界面，其中包含你的 API 文档。
结论
现在，你已经学会了如何使用 Fastify 和 Swagger 创建 API 文档。虽然本文只介绍了一些基础知识，但你可以使用这些知识构建更加强大和灵活的 API。
完整代码如下：
----- ------- - --------------------
----- -------------- - --------------------------
-------------------------------- -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- ---------------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
--
---------------- -
------- -
--------- -
---- -
----- ---------
----------- -
------ -
----- --------
-
-
-
-
-
-- ----- --------- ------ -- -
------ - ------ ------- -
--
--------------------
--------------- -- ------------------- --------- -- -------------
------------ -- -------------------参考文献：
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/670baf8e66ef9cf37fab2f98