Swagger 是一个流行的 API 文档工具，可以帮助开发者自动化地生成和维护 API 文档。Fastify 是一个快速、低开销的 Node.js Web 框架，支持异步编程和处理高负荷。
在本文中，我们将介绍如何使用 Fastify 集成 Swagger API 文档。我们将首先安装 Fastify 和 Swagger，然后创建一个简单的 REST API，并将其使用 Swagger 进行文档化。最后，我们将介绍如何使用 Swagger UI，通过浏览器查看和测试 API。
安装 Fastify 和 Swagger
我们需要先安装 Fastify 和 Swagger。在终端中运行以下命令即可安装它们：
--- ------- ------- ------ --- ------- --------------- ------
创建 REST API
接下来，我们将创建一个简单的 REST API，以演示如何在 Fastify 中集成 Swagger。
----- ------- - -------------------- ------- ---- --
-- ------ - --- -----
--------------------- ----- --------- ------ -- -
------ - ------ ------- -
--
-- --- --- ------
----- ----- - ----- -- -- -
--- -
----- --------------------
------------------------ --------- -- ----------------------------------
- ----- ----- -
----------------------
---------------
-
-
-------上述代码定义了一个 /hello 路由，它返回一个包含 hello: 'world' 的 JSON 对象。
集成 Swagger
接下来，我们将修改我们的代码，以便将 Swagger 集成到我们的 API 中。
我们将使用的是 fastify-swagger 插件。这个插件会自动为我们生成 Swagger API 文档，并提供一个 Swagger UI 界面，使得我们可以通过浏览器进行测试。
----- ------- - -------------------- ------- ---- --
----- -------------- - --------------------------
-- ------ - --- -----
--------------------- ----- --------- ------ -- -
------ - ------ ------- -
--
-- -------- -------
-------------------------------- -
------------ -----------------
-------- -
----- -
------ ----- ---------
------------ -------- --- ------- ------- -----
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
--------- ---------------------
--------- --------------------
--
------------ ----
--
-- --- --- ------
----- ----- - ----- -- -- -
--- -
----- --------------------
------------------------ --------- -- ----------------------------------
- ----- ----- -
----------------------
---------------
-
-
-------在上面的代码中，我们向 Fastify 中注册了 fastify-swagger 插件，并将其配置为暴露文档接口。我们还为 Swagger API 提供了标题、描述和版本信息，并为其定义了一个外部文档链接。
现在，我们可以通过访问 /documentation/json 接口获取生成的 Swagger API 文档。而且，我们可以通过浏览器访问 /documentation，打开 Swagger UI 界面，开始测试和探索 API。
结论
在本文中，我们学习了如何在 Fastify 中使用 fastify-swagger 插件，集成 Swagger API 文档和 Swagger UI 界面。我们创建了一个简单的 REST API，并将其文档化。在实践中，使用 Swagger 可以减少文档工作量，让开发者能够更好地理解 API，并快速测试和迭代。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67065250d91dce0dc85bb5a2