在 Fastify 中以中间件的方式加入多个 Swagger 文档
Fastify 是一个快速、简单且低开销的 Web 框架，它的特点是高效、专注于开发和提供非常强的性能，因此它在性能要求较高的项目中被广泛使用。
Swagger 是一种规范，它定义了一种用于描述 RESTful 的 Web 服务的语言（OpenAPI Specification）。Swagger 可以帮助前端和后端程序员协调构建出开放的 API，然后可以在程序代码中自动生成客户端的请求代码，以及方便地进行文档的生成。
在使用 Fastify 开发 RESTful API 的时候，往往需要使用 Swagger 进行文档的生成，而且可能需要使用多个 Swagger 文档来描述不同的 API 和参数。
在 Fastify 中，可以通过中间件的方式快速地加入多个 Swagger 文档。本文将详细介绍这个过程，并提供示例代码。
步骤 1：安装 Swagger 插件
安装好 Fastify 框架后，可以直接在项目中使用fastify-swagger插件来为自己的 RESTful API 快速生成 Swagger 文档。
npm install --save fastify-swagger
步骤 2：编写 Swagger 文档
编写 Swagger 文档的方式有很多种，但是我们这里介绍官方提供的方式，也是最为简单且易于使用的方式：
-- -------------------- ---- -------
----- -------------- - -
------------ -----------------
------------ -----
-------- -
----- -
------ ----- -----
------------ ----- --- ---------------
-------- --------
--
------------- -
---- ---------------------
------------ ----- ---- ---- ------
--
----- ------------
-------- ---------
--------- ---------------------
--------- ---------------------
--
--上述代码定义的是一个 Swagger 文档的基本内容，具体的含义可以参考 Swagger 官方文档进行了解。
步骤 3：建立多个 Swagger 文档
假设现在我们的项目中有两个 RESTful API 需要建立 Swagger 文档，直接使用上述方式定义一个 Swagger 文档是不太可行的。因此，我们可以通过建立多个 Swagger 文档来解决这个问题。
下面是一个示例代码，通过建立多个 Swagger 文档的方式可以非常简单地解决这个问题：
-- -------------------- ---- -------
----- ------- - --------------------
------- -----
---
-------------------------------------------- -
------------ -----
------------ -----------------
-------- -
----- - ------ ----------------- ------------ -------- --- ------- ------- ----- -------- ------- --
--
---
-------------------------- -------- -------------- -
----- --- - -----------------
-- ----------------------- -
-------------------------------------------- -
------------ -----
------------ --- - -----------------
-------- -
----- - ------ ----------------- ------------ -------- --- ------- ------- ----- -------- ------- --
--
---
-
---
---------------
------- ------
---- -----------
------- -
------------ -
----- - ----- -------- --
----------- - ----- --------- --
--
--------- -
---- -
----- ---------
----------- -
------ - ----- -------- --
--
--
--
--
-------- -------- ----- ------ -
------------ ------ ----------- ---
--
---
---------------
------- ------
---- -----------
------- -
------------ -
----- - ----- -------- --
----------- - ----- --------- --
--
--------- -
---- -
----- ---------
----------- -
------ - ----- -------- --
--
--
--
--
-------- -------- ----- ------ -
------------ ------ ----------- ---
--
---
-------------------- -------- ----- -------- -
-- ----- -
-----------------------
----------------
-
------------------------ --------- -- -------------
---在上述示例代码中，我们在程序运行前，通过使用 fastify.register 方法，为我们的每个 RESTful API 都建立了一个 Swagger 文档。
if (url.startsWith('/v2')) 这一行表示只有 URL 以 /v2 开头的时候才会自动注册 Swagger，避免无用的 Swagger 文档的注册。
当我们访问 http://localhost:3000/v1/test/documentation/ 和 http://localhost:3000/v2/test/documentation/ 的时候，将分别获得两个 Swagger 文档的内容。
总结
Fastify 是一个高效的 Web 框架，而 Swagger 可以帮助我们快速地生成 RESTful API 的文档，这两者结合起来可以非常方便地进行开发。在 Fastify 中使用 fastify-swagger 插件，我们可以非常简单地实现多个 Swagger 文档的生成，在项目开发中可以提高工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64c50f4fd20074f47a453617