Fastify 是一款快速且低开销的 Web 框架，由于其优秀的性能和易用性，已经成为了许多企业中前端团队的首选。但是，如果我们想要更好地管理我们的 API 文档，便需要使用到 Swagger 这一工具。
Swagger 是一种标准化的规范，用于描述 RESTful API。通过使用 Swagger，我们可以自动生成 API 文档、交互式 API 测试工具等等。在本文中，我们将学习如何在 Fastify 中使用 Swagger 这一工具。
安装 Fastify
首先，我们需要安装 Fastify。可以通过以下命令进行安装：
npm install fastify
安装 fastify-swagger
接下来，我们需要安装 fastify-swagger 这一插件。可以通过以下命令进行安装：
npm install fastify-swagger
配置 Swagger
接下来，我们需要配置 Swagger。在 Fastify 中，我们可以通过使用 fastify-swagger 插件来配置 Swagger。以下是基本的配置代码：
-- -------------------- ---- -------
----- ------- - --------------------
----- ------- - --------------------------
----- ------- - -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- --- ---------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- ------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
-
------------------------- --------在上面的代码中，我们使用了路由前缀 '/documentation'，因此我们接下来可以通过访问该路由来查看我们生成的 API 文档。options.swagger 中是一些基本的信息，比如 API 标题、描述、版本等等。对于一个真实的项目，我们可以通过此处进行修改和完善。
编写 API
为了让 Swagger 可以正确地读取我们的 API，我们需要编写一些 API。以下是一个示例 API：
-- -------------------- ---- -------
------------------- -
------- -
------------ ---- -----
----- --------
-------- --------- -----
--------- -
---- -
------------ ----------- ----------
----- ---------
----------- -
-------- - ----- -------- -
-
-
-
-
-- ----- ------ -- -
------------ -------- ------ ---- --------- --
--在上面的代码中，我们使用了 Fastify 的路由系统来定义一个 GET /api 的路由。我们还将该路由的一些描述信息存储了起来，包括描述、标记、摘要等等。
查看 API 文档
现在，我们已经完成了 Swagger 的配置和 API 的编写，接下来就可以访问 /documentation 路由来访问我们生成的 API 文档了。此处提供了一个完整的代码示例：
-- -------------------- ---- -------
----- ------- - --------------------
----- ------- - --------------------------
----- ------- - -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- --- ---------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- ------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
-
------------------------- --------
------------------- -
------- -
------------ ---- -----
----- --------
-------- --------- -----
--------- -
---- -
------------ ----------- ----------
----- ---------
----------- -
-------- - ----- -------- -
-
-
-
-
-- ----- ------ -- -
------------ -------- ------ ---- --------- --
--
-------------------- ----- -------- -- -
-- ----- ----- ---
------------------- --------- -- ------------
--总结
通过本文，我们了解了如何在 Fastify 中使用 Swagger 来管理我们的 API 文档。使用该工具，我们可以轻松地生成并维护 API 文档，提高了我们的开发效率。同时，Swagger 还提供了许多其他的功能，比如交互式 API 测试，可以进一步提高我们的开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6467d213968c7c53b081d345