Swagger 是一种 API 文档规范，可以帮助我们更好地管理和维护我们的 API。在前端开发中，我们通常使用 Fastify 作为服务器框架，本文将介绍如何在 Fastify 中集成 Swagger 文档。
安装依赖
在开始之前，我们需要安装一些依赖。首先，我们需要安装 fastify-swagger：
--- ------- ---------------
然后，我们还需要安装 fastify-oas：
--- ------- -----------
配置 Swagger
在我们的 Fastify 应用程序中，我们需要配置 Swagger。我们可以在 app.js 文件中添加以下代码：
----- ------- - --------------------
---------------------------------------- -
------------ -----------------
-------- -
----- -
------ -------- -----
------------ ---- ------------- --- ---------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
--------- ---------------------
--------- --------------------
--
------------ ----
--在这个配置中，我们指定了 Swagger 的基本信息，包括标题、描述和版本。我们还指定了外部文档的 URL，以及我们的 API 使用的媒体类型。
我们还指定了 Swagger 的路由前缀为 /documentation，这意味着我们的 Swagger 文档将在 http://localhost:3000/documentation 上可用。
最后，我们将 exposeRoute 设置为 true，这意味着我们的 Swagger 文档将自动包含在我们的路由中。
添加路由
现在我们已经配置了 Swagger，我们需要添加一些路由。我们可以在 app.js 文件中添加以下代码：
--------------------- -
------- -
------------ -
----- - ----- -------- -
-
-
-- --------- ------ -- -
----- - ---- - - -------------
----- ------- - ------- ---------
------------ ------- --
--在这个路由中，我们使用了 Fastify 的 schema 选项来定义请求参数的类型。在 Swagger 文档中，这将被自动识别并添加到我们的文档中。
查看 Swagger 文档
现在我们已经完成了所有配置和路由，我们可以查看我们的 Swagger 文档。我们可以在浏览器中访问 http://localhost:3000/documentation，就可以看到我们的 Swagger 文档了。
在 Swagger 文档中，我们可以查看我们的 API 的所有路由和参数，并且我们可以使用 Swagger UI 来测试我们的 API。
总结
在本文中，我们介绍了如何在 Fastify 中集成 Swagger 文档。我们学习了如何配置 Swagger，并添加路由和参数。最后，我们查看了我们的 Swagger 文档，并使用 Swagger UI 来测试我们的 API。这些技能对于前端开发人员来说非常重要，因为它们可以帮助我们更好地管理和维护我们的 API。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/66320b31d3423812e4fadd27