Fastify 是一款快速、低开销的 Node.js Web 框架。它拥有很多出色的特性和性能，使得它成为许多开发者的首选框架。其中一个优秀的特性就是支持 Swagger UI 文档。Swagger 是一个流行的 API 规范，它提供了应用程序接口的描述和交互式文档。在本文中，我们将学习如何在 Fastify 中使用 Swagger UI 文档。
什么是 Swagger UI
Swagger UI 是一个开源的工具，用于可视化和交互式地访问 RESTful Web 服务的 API 文档。它基于 Swagger 规范构建，并支持 JSON 和 YAML 格式的 API 描述文件。Swagger UI 的操作非常简单，只需要在浏览器中打开 Swagger UI 页面，输入 API 的文档地址即可。然后你就可以在页面上交互地体验 API 文档，测试 API 接口，查看参数和响应等信息。
Fastify 中使用 Swagger UI
下面我们将介绍如何在 Fastify 中使用 Swagger UI。
安装 Swagger 插件
在 Fastify 中使用 Swagger UI，首先需要安装 fastify-swagger 插件。在终端中使用以下命令进行安装。
npm install --save fastify-swagger
注册 Swagger 插件
在使用 Fastify 的时候，我们需要在应用程序中注册插件。我们可以在 Fastify 实例化的时候使用 register 方法来注册插件。下面是一个使用 Swagger 插件的示例代码。
-- -------------------- ---- -------
----- ------- - ---------------------
-------------------------------------------- -
------------ -----
------------ --------
-------- -
----- -
------ --- -----
------------ -- ------ ---- -----
-------- -------
--
----- -----------------
-------- ---------
--------- ---------------------
--------- ---------------------
----- -
- ----- -------- ------------ ----- ------- ----------- --
- ----- ------- ------------ --------------- ------- ----------- -
-
-
---在上面的代码中，我们注册了 fastify-swagger 插件，并为其提供了一些配置信息。其中，exposeRoute 表示是否将 Swagger UI 的路由暴露出来。routePrefix 是 Swagger UI 的路由前缀。swagger 是 Swagger UI 的配置信息。你可以在这里指定标题、描述、主机、协议、接收类型、输出类型和标签等信息。
需要注意的是，如果你使用了一些插件来处理请求和响应，那么你需要将 Swagger 插件放在它们之后注册，否则可能会出现问题。
添加路由
在添加了 Swagger 插件之后，我们需要添加一些路由来描述我们的 API 接口。下面是一个简单的路由示例。
-- -------------------- ---- -------
------------------------- -
------- -
------- -
----- ---------
----------- -
--- -
----- ----------
-------- -
-
--
--------- ------
-
-
-- -------- --------- ------ -
----- ------ - ------------------
-- ----- ------
------------ --- ------ ---
---在上面的代码中，我们定义了一个路由 /users/:id，包含一个名为 id 的参数。我们使用 schema 对象来定义路由的参数验证规则。在示例中，我们要求 id 参数必须是正整数。在操作完数据之后，我们使用 reply.send 方法来返回数据给客户端。
访问 Swagger UI
在完成了上面两步之后，我们可以通过浏览器访问 Swagger UI 页面了。只需要在浏览器输入 Fastify 服务器的地址，加上配置的 Swagger UI 路由前缀即可。例如，如果 Swagger UI 的路由前缀是 /docs，则可以访问 http://localhost:3000/docs。
当我们访问 Swagger UI 页面的时候，会看到一个交互式的 API 文档页面，其中包含了我们定义的接口信息、参数、响应等。我们可以在页面上直接测试接口，查看参数和响应等信息。
总结
在本文中，我们介绍了 Fastify 框架中如何使用 Swagger UI 文档。我们学习了安装 Swagger 插件、注册 Swagger 插件、添加路由和访问 Swagger UI 页面等步骤。通过这些步骤，我们可以快速、简单地建立起一个具有高效、交互式的 API 文档的应用程序。希望本文能为您提供参考和帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6455b874968c7c53b091f279