Fastify 是一个高度聚焦于性能的 Web 框架，它的设计理念是基于 Node.js 核心的 http 模块，让 web 应用程序更具优化、自由度和可靠性。Swagger UI 则是一款基于 OpenAPI 规范的 API 文档可视化工具，可以通过它直观地查看接口文档，参数，Header 等信息。本文将介绍在 Fastify 中使用 Swagger UI 展示 API 文档的方法及注意点。
1. 安装依赖
在使用 Swagger UI 之前，需要安装必要依赖：
--- ------- --------------- ------ --- ------- ----------------- ------
2. 配置 Fastify
在 Fastify 应用中，我们需要配置 Swagger UI 所需的数据和路由信息。下面是一个示例：
----- ------- - ------------------
-------------------------------------------- -
------------ -----
------------ -----------------
-------- -
----- -
------ ----- -----
------------ -------- --- --------------- -----
-------- -------
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
-
--
---------------------------------------------- -
------------ -----
------------- ----------------------
-------- -
----- -
------ ----- --- ---------------
------------ -------- --- --------------- --- ---------------
-------- -------
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
-
--
-------------------- ----- -------- -- -
-- ----- ----- ---
------------------- --------- -- ------------
--在这个例子中，我们启用了 Swagger UI 的展示和路由功能，并且配置了文档的基本信息和访问地址。注意其中的 exposeRoute 属性，它表示是否启用 UI 的路由功能。
3. 定义路由和 API
接下来我们需要定义路由和接口的定义，这里给出一个简单的示例：
---------------
------- ------
---- --------------------
------- -
------- -
--- - ----- --------- -
--
--------- -
---- -
----- ---------
----------- -
--- - ----- --------- --
----- - ----- -------- -
-
-
-
--
-------- ----- --------- ------ -- -
----- - -- - - --------------
------ - --- ----- ----- ------ -
-
--这里我们定义了一个 /api/v1/users/:id 的 GET 请求，它需要一个 id 参数，并且返回一个包含 id 和 name 属性的 JSON 对象。在这个示例中，我们使用了 Fastify 中提供的 schema 属性来定义接口的参数和返回的数据格式。
4. 启动 Fastify 应用
现在我们可以启动这个 Fastify 应用并查看 Swagger UI 页面了。访问 http://localhost:3000/documentation/ 即可看到我们刚刚定义好的接口信息。在页面上可以查看路由信息、请求参数、响应结果等内容。
总结
本文介绍了在 Fastify 应用中使用 Swagger UI 展示 API 文档的方法，并给出了详细的代码示例。通过对接口的定义、Swagger UI 的配置等相关内容的了解，可以方便地在自己的项目中使用 Swagger UI 来展示 API 文档，提高效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6520bcb095b1f8cacd82db17