Fastify 是一款快速高效的 Node.js Web 框架，它的设计目标是让开发者能够构建出性能优越的 RESTful API 服务。而其中使用的文档生成器，可以帮助开发者快速生成规范的 API 文档，方便使用者了解 API 接口的使用方式和参数要求。
Fastify-swagger
Fastify-swagger 是一款基于 Fastify 的 REST API 文档生成器，它可以自动生成完整的 API 文档，并且可以通过 Swagger UI 进行可视化展示。
Fastify-swagger 的使用非常简单，只需通过 npm 来安装 fastify-swagger 模块，然后在 Fastify 应用程序中添加如下代码：
-- -------------------- ---- -------
----- -------------- - ---------------------------
-------------------------------- -
------------ -----------------
-------- -
----- -
------ ----- ---------
------------ -------- --- ------- ------- -----
-------- -------
--
------------- -
---- ---------------------
------------ ----- ---- ---- -----
--
----- -----------------
-------- ---------
--------- ---------------------
--------- ---------------------
--
------------ ----
---这段代码中，我们通过 fastifySwagger 模块将 Swagger UI 注册到 Fastify 上，并设置了一些 Swagger 相关的元数据，如标题、描述、版本、协议、消费者和生产者等。
在添加完上述代码后，我们就可以通过 /documentation 访问 Swagger UI，并且查看生成的 API 文档了。
Fastify-swagger 示例
下面我们来看一个示例代码，模拟一个简单的计算器 API 接口。
-- -------------------- ---- -------
----- ------- - ---------------------
----- -------------- - ---------------------------
-------------------------------- -
------------ -----------------
-------- -
----- -
------ ----------- -----
------------ -- ------ ---------- --- ---- ------- --- ---------
-------- -------
--
------------- -
---- ---------------------------------------------
------------ ----- ---- ---- -----
--
-------- ---------
--------- ---------------------
--------- ---------------------
--
------------ ----
---
------------------- -
------- -
------------ -
----- ---------
--------- ----- -----
----------- -
-- -
----- --------
--
-- -
----- --------
-
-
-
-
-- ----- ------ -- -
----- - -- - - - ----------
------------ ------- - - - ---
---
-------------------- ----- -------- -- -
-- ----- ----- ----
------------------- --------- -- -------------
---在这个示例中，我们首先通过 fastify-swagger 注册了 Swagger UI，并设置了 API 的一些元数据。然后，我们定义了一个 /sum 的 get 接口，通过 schema 属性定义了请求参数 a 和 b 的类型和必要性。接着，我们在回调函数中实现了计算 a+b 的逻辑，最后将结果返回。
如果我们访问 /documentation，就可以看到该 API 对应的 Swagger UI 界面，其中展示了 /sum 接口的参数要求和返回值。
总结
Fastify-swagger 是一款快速高效的 REST API 文档生成器，它通过 Swagger UI 可以自动生成规范的 API 文档，方便使用者使用 API 接口。我们可以通过 Fastify 的 schema 属性来定义接口的请求参数和返回值。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6485666848841e989443ff3e