Fastify 是一种快速、低内存占用并且简单易用的 Node.js Web 框架。与 Express 和 Koa 不同，Fastify 的核心设计理念是性能和稳定性。而 Swagger 是一种流行的 API 文档工具，可以方便地生成 API 文档、验证 API 数据。本文将介绍如何在 Fastify 应用中集成 Swagger，帮助开发者快速构建高效、易维护的 API 服务。
安装 Fastify 和 Swagger
在开始之前，我们需要全局安装 Fastify 和 Swagger 工具，执行下面的命令即可：
npm install -g fastify swagger
创建 Fastify 应用
创建一个新的 Fastify 应用非常简单，只需要几行代码即可：
-- -------------------- ---- -------
----- ------- - --------------------
---------------- ----- --------- ------ -- -
------ - ------ ------- -
--
-------------------- ----- -- -
-- ----- -
------------------
---------------
-
--上面的代码中，我们创建了一个 Fastify 实例并添加了一个简单的路由处理程序。现在我们可以使用 node app.js 命令启动这个应用，并在浏览器中访问 http://localhost:3000/，应该能看到返回的 JSON 数据。
集成 Swagger
要在 Fastify 应用中集成 Swagger，我们需要使用 fastify-swagger 插件，这个插件用于生成 Swagger 文档并将其与 Fastify 应用集成。执行以下命令安装该插件：
npm install fastify-swagger
在 Fastify 应用中使用 fastify-swagger 插件非常简单。只需调用 Fastify 实例的 register 方法即可：
-- -------------------- ---- -------
----- ------- - --------------------
----- ------- - --------------------------
------------------------- -
------------ -----------------
-------- -
----- -
------ --- -----
------------ ---- ---------------
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- -----------------
-------- ---------
--------- ---------------------
--------- --------------------
--
------------ ----
--
---------------- ----- --------- ------ -- -
------ - ------ ------- -
--
-------------------- ----- -- -
-- ----- -
------------------
---------------
-
--上面的代码中，我们调用 fastify.register 方法并传递 swagger 插件以及生成 Swagger 文档所需的配置。配置中的 routePrefix 属性用于指定生成的 Swagger 文档的路径，swagger.info 用于指定 Swagger 文档的基本信息，包括 title、description 和 version 等信息。host 属性用于指定 API 的主机名和端口号，schemes 属性用于指定 API 协议，consumes 和 produces 属性用于指定 API 的请求和响应格式。
在 Fastify 应用运行时，访问 http://localhost:3000/documentation 即可看到生成的 Swagger 文档：
如上图所示，Swagger 文档自动将 Fastify 应用中的所有路由显示出来，并显示了每个路由的请求参数、响应数据类型以及其他相关信息。
使用 Swagger 编写 API
Swagger 提供了一个类似于 OpenAPI 的 API 规范，我们可以使用这个规范来定义和描述 API，Swagger 将自动根据这个规范生成 API 文档。
下面是一个快速入门例子，我们将使用 Swagger 规范编写一个简单的 API，该 API 接受两个数字，将它们相加并返回它们的和。
-- -------------------- ---- -------
-------- -----
-----
------ -- ---
------------ --- -------------
-------- -----
----- --------------
--------- -
---------
- ----------------
---------
- ----------------
------
-----
-----
-------- --- --- -------
------------ --- --- ------- --- ------ ----- ---
-----
- ----
-----------
-
----- ----
--- --------
------------ --- ----- ------
--------- ----
----- -------
-
----- ----
--- --------
------------ --- ------ ------
--------- ----
----- -------
----------
------
------------ --
-------
----- -------
--------------------
-------
----- ------
----- -----------
--- ------
---------
- ------- --上面的代码使用 YAML 格式编写了一个简单的 API 规范，其中 /add 路由处理程序用于计算两个数字的和。按照 Swagger 规范，我们定义了路由的请求参数（num1 和 num2）以及响应数据类型。在实际应用中，可以使用相应的 Fastify 插件来解析和验证请求数据，并将响应数据序列化为 JSON 格式。
总结
本文介绍了如何在 Fastify 应用中使用 Swagger 插件，通过 Swagger 我们可以快速构建高效、易维护的 API 服务。使用 Swagger 规范编写 API 规范有助于提高 API 开发的效率和一致性。希望这篇文章能够帮助到你。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6471d212968c7c53b0fbcd53