什么是 Fastify
Fastify 是一个快速、低开销的 Web 框架，可以用于部署 Node.js 应用程序。它在效率和性能方面优于很多其他流行的 Web 框架，比如 Express 和 Koa。
Fastify 尤其适合用于编写高并发 Node.js 服务，因为它内置了异步处理、流控制和缓存等机制，这些机制可以很好地支持高负载的 Web 请求。
什么是 OpenAPI
OpenAPI 原名 Swagger，是一种用于描述和管理 RESTful Web 服务的规范。它可以把 Web 服务的 API 描述和接口规范写成一份文档，供开发者参考和使用。
使用 OpenAPI 可以让 API 的开发者和使用者更好地协作，从而更好地构建出易于使用、易于管理、易于维护的 Web 服务。
Fastify 中部署 OpenAPI 的方法
部署 OpenAPI 在 Fastify 中非常简单，只需要使用 fastify-oas 插件即可。以下是具体步骤：
步骤一：安装 fastify-oas
使用 npm 进行安装：
npm i fastify-oas
步骤二：创建 Fastify 应用程序
在代码中引入 Fastify 库和 fastify-oas 插件：
const fastify = require('fastify')({ logger: true })
const fastifyOas = require('fastify-oas')设置 fastify-oas 插件的配置项：
-- -------------------- ---- -------
----- ------- - -
------------ -----------------
------------ -----
-------- -
----- -
------ ----- -----
------------ -------- --- ----------- --------
-------- -------
--
-------- --
---- ------------------------
------------ ------ -------
--
-
-步骤三：注册 fastify-oas 插件
fastify.register(fastifyOas, options)
步骤四：定义路由
fastify.get('/', (request, reply) => {
reply.send({ hello: 'world' })
})步骤五：启动服务器
-- -------------------- ---- -------
----- ----- - ----- -- -- -
--- -
----- --------------------
- ----- ----- -
----------------------
---------------
-
-
-------步骤六：访问文档
在浏览器中将 URL 输入为 http://localhost:3000/documentation，即可访问生成的 OpenAPI 文档。
示例代码
下面是一个完整的 Fastify 应用程序代码，内嵌了 fastify-oas 插件，同时定义了一个包含 2 个路由的 API：
-- -------------------- ---- -------
----- ------- - -------------------- ------- ---- --
----- ---------- - ----------------------
----- ------- - -
------------ -----------------
------------ -----
-------- -
----- -
------ -------- -----
------------ ---- ------- ---- ----------- --------
-------- -------
--
-------- --
---- ------------------------
------------ ------ -------
--
-
-
---------------------------- --------
---------------- ----- --------- ------ -- -
------ - ------ ------- -
--
--------------------------- ----- --------- ------ -- -
----- ---- - -------------------
------ - -------- ------- --------- -
--
----- ----- - ----- -- -- -
--- -
----- --------------------
- ----- ----- -
----------------------
---------------
-
-
-------总结
通过以上步骤，我们可以很方便地在 Fastify 应用程序中部署 OpenAPI 文档，从而能够更好地管理 API 接口，提高 Web 服务的可维护性和易用性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/65a196feadd4f0e0ff9a6477