Fastify 是一个高效、低开销、高度可定制的 Node.js Web 框架。在 Web 应用开发过程中，文档是至关重要的一部分，因为它能够帮助开发者清晰地了解应用的功能和使用方式。Swagger UI 是一种可以自动生成 API 文档的解决方案，本文将介绍如何为您的 Fastify 应用程序创建 Swagger UI 文档。
步骤一：安装 Fastify 和 Swagger UI
运行以下命令安装 Fastify 和 Swagger UI：
npm install fastify swagger-ui
步骤二：为 Fastify 应用程序添加 Swagger 插件
要使用 Swagger UI，您需要使用 fastify-swagger 插件。通过运行以下代码，您可以将其添加到您的 Fastify 应用程序：
-- -------------------- ---- -------
----- ------- - --------------------
----- ------- - --------------------------
------------------------- -
------------ --------
-------- -
----- -
------ --- -----
------------ ---- ---------------
-------- -------
--
----- -
- ----- ------- ------------ ----- ------- ----------- --
- ----- ------- ------------ ----- ------- ----------- -
--
-------- ---------
--------- ---------------------
--------- ---------------------
-------------------- -
------- -
----- ---------
----- ---------
--- --------
-
-
--
------------ ----
--上面的代码中，我们为 Fastify 应用程序添加了 Swagger UI，并定义了 Swagger UI 的相关配置，包括 routePrefix、info、tags、schemes、consumes、produces 和 securityDefinitions。其中，securityDefinitions 定义了 API 访问所需要的认证信息。最后，exposeRoute 表示是否在 /docs 路径上公开 Swagger UI。
步骤三：为您的 Fastify 路由添加 Swagger 标记
在您的 Fastify 应用程序中添加 Swagger 标记，以便 Swagger UI 能够自动生成文档。运行以下代码：
-- -------------------- ---- -------
------------------------- -
------- -
------------ ---- - ------
----- ---------
------- -
----- ---------
----------- -
--- -
----- ----------
------------ ----- ---
-
-
--
--------- -
---- -
------------ ----------- ----------
----- ---------
----------- -
--- -
----- ----------
------------ ----- ---
--
----- -
----- ---------
------------ ----- -----
-
-
--
---- -
------------ ---- ------
-
-
-
-- ----- ------ -- -
-- ---
--在上面的代码中，我们定义了 /users/:id 路由的相关信息，包括描述、标记、参数和响应。此外，我们还可以将一些路由参数标记为可选参数或必选参数等。
步骤四：启动 Fastify 应用程序并查看 Swagger UI 文档
现在，我们已经为我们的 Fastify 应用程序添加了 Swagger UI 插件和 Swagger 标记。只需要启动 Fastify 应用程序并访问 /docs 路径，我们就可以查看自动生成的 Swagger UI 文档了。运行以下代码启动 Fastify 应用程序：
fastify.listen(3000, err => {
if (err) {
console.error(err)
process.exit(1)
}
console.log('Server running on port 3000')
})打开浏览器并访问 http://localhost:3000/docs，您就可以看到自动生成的 Swagger UI 文档了。
结论
在本文中，我们介绍了如何为 Fastify 应用程序创建 Swagger UI 文档。我们通过安装 Fastify 和 Swagger UI 插件，并为 Fastify 应用程序添加了 Swagger 标记来实现这一目标。这些步骤将让开发者更加容易地创建和维护 API 文档，从而提高了开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/675019b4fbd23cf890735915