前言
Fastify 是一个快速、低开销、可扩展的 Node.js Web 框架，旨在为开发者提供稳定性能和服务。Swagger UI 是一个流行的开源工具，提供了一个可视化界面，可让用户更方便地了解和测试 API 接口的描述和信息。在本文中，我们将介绍如何在 Fastify 框架中使用 Swagger UI。
准备工作
在开始之前，我们需要安装 Fastify 和 Swagger UI。可以使用 npm 包管理器来安装它们:
npm install fastify npm install fastify-swagger
这里我们使用 fastify-swagger 插件，以便在 Fastify 中使用 Swagger UI。
安装 Swagger UI
如果你没有安装 Swagger UI，可以使用以下命令安装:
npm install swagger-ui-dist
添加 Swagger UI 到 Fastify
Fastify 的插件系统使添加 Swagger UI 成为一个简单的步骤。我们只需在 Fastify 的插件注册中使用 fastify-swagger 就行了：
-- -------------------- ---- -------
----- ------- - ---------------------
----- ------- - ---------------------------
------------------------- -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ -------- --- ------- ------- -----
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
---这里，我们将 Swagger UI 显示在 /documentation 路径下。info 选项包含有关我们 API 的信息。externalDocs 选项可用于提供其他有关 API 的信息。host 是我们的服务器地址，schemes 用于定义协议，此处为 http。consumes 和 produces 用于指定 API 的输入输出格式。
添加路由
现在我们已经安装并添加了 Swagger UI 插件到 Fastify，我们需要添加一些路由来测试 Swagger UI。
-- -------------------- ---- -------
-------------------------- -
------- -
------------ ---- - --------
----- -----------
------- -
----- ---------
----------- -
--- -
----- ---------
------------ ---- ------ ---------- --- - -------
-
-
--
--------- -
---- -
----- ---------
----------- -
----- -
----- ---------
------------ -- ------ -----
-
-
-
-
-
-- ----- --------- ------ -- -
----- -- - ------------------
----- ------ - ----- ------------------
------ - ----- ----------- --
---
----------------------- -
------- -
------------ ------- - --- --------
----- -----------
----- -
----- ---------
----------- -
----- -
----- ---------
------------ -- ------ -----
-
--
--------- --------
--
--------- -
---- -
----- ---------
----------- -
--- -
----- ---------
------------ ---- ------ ---------- --- - -------
-
-
-
-
-
-- ----- --------- ------ -- -
----- ---- - ------------------
----- -- - ----- -------------------
---------------------- -- ---
---这两个路由分别是获取人和创建人的路由，我们还为它们提供了详细的 swagger schema 描述，以便 Swagger UI 可以使用。
测试 Swagger UI
现在我们已经添加了路由和 Swagger 描述，我们可以打开 Swagger UI 并测试我们的 API。打开浏览器，转到 http://localhost:3000/documentation，应该可以看到 Swagger UI 界面打开。
在 Swagger UI 中，你可以看到我们的两个路由，试着在这个界面中尝试它们，并观察请求和响应的详细信息。
结论
在本文中，我们详细介绍了如何在 Fastify 框架中使用 Swagger UI，从添加插件到添加路由以测试 Swagger UI。我们希望这将帮助你更好地了解如何使用 Fastify 和 Swagger UI 来构建 API 服务。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6773a4226d66e0f9aae5a04c