Swagger 是一种 RESTful API 的设计规范和交互式文档系统，可以帮助开发人员描述、生成功能完整、可读性更好的 RESTful API，让用户更容易地理解和使用 API。同时 Swagger UI 是常用的生成 REST API 文档的工具之一。在本文中，我们将介绍如何在 Fastify 应用程序中使用 Swagger UI。
什么是 Fastify？
Fastify 是一种快速和低开销的 Web 框架，旨在提供最佳的性能和开发体验。相较于其他 HTTP 框架，它具有更少的抽象层和更好的性能表现。它支持 async/await，可以轻松地结合其他库进行使用。
集成 Swagger UI
在 Fastify 中，集成 Swagger UI 很容易。首先，您需要安装 fastify-swagger 包。
npm install --save fastify-swagger
然后，在您的 Fastify 应用程序中注册 Swagger 插件。
-- -------------------- ---- -------
----- ------- - --------------------
------- ----
--
-------------------------------------------- -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- ------------- --- ---------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- ------
--
----- -----------------
-------- ---------
--------- ---------------------
--------- ---------------------
--
------------ ----
--
-------------------- ----- -------- -- -
-- ----- ----- ---
------------------- --------- -- ------------
--在上面的示例代码中，fastify-swagger 插件的 routePrefix 被设置为 /documentation，这意味着 Swagger UI 将被放置在 localhost:3000/documentation。为了保护您的 API 文档，您可以设置此路径需要进行身份验证才能获得访问权限。
swagger 对象包含有关您的 API 的所有信息。Swagger UI 将使用此信息显示您的 API 文档。您可以设置外部文档网址、API 主机、支持的传入和传出数据类型等。
一旦设置完毕，您就可以使用 Swagger UI 访问您的 API 文档了。在浏览器中导航至 http://localhost:3000/documentation 即可看到 Swagger UI 界面。
使用 Swagger UI
Swagger UI 界面本质上是一个可视化的交互式 API 文档，您可以使用它来测试、验证和理解您的 API。在 Swagger UI 中，您可以浏览 API 文档，提供必需的输入值并调用 API。下面是 Swagger UI 界面的截图。
例如，让我们来看一个快速的例子。假设我们有一个处理用户的 API，我们想知道如何使用 Swagger UI 调用它。下面是这个 API 的代码：
fastify.get('/user/:id', async (request, reply) => {
const userId = request.params.id
const user = await getUser(userId)
return user
})在 Swagger UI 界面中，您可以找到 API 文档，并使用提供的 “Try it out” 按钮来调用 API。例如，我们想获取 ID 为 1 的用户。我们可以提供 id 参数和 GET /user/:id 路径，如下所示。
然后，我们点击“Execute”按钮，并在下面的“Responses”区域中查看响应。在这种情况下，我们应该能够看到返回的 JSON 对象，它代表 ID 为 1 的用户。
结论
Fastify 是一款快速和低开销的 Web 框架，非常适合构建高性能的 RESTful API。在 Fastify 中，集成 Swagger UI 很容易。我们在本文中展示了如何使用 Fastify 和 Swagger UI 创建 API 文档，并提供了一个快速的示例。如果您的应用程序正在开发或者已经在使用 Fastify，那么将 Swagger UI 集成进去将会是一个很好的选择。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/674a71f0a1ce0063548e387e