Fastify 是一个快速、开源的 Web 框架，它是 Node.js 的一个高性能 HTTP 服务器，可以创建高效的 Web 应用程序，遵循一些最佳实践可以使使用 Fastify 构建 RESTful API 变得轻而易举。
快速开始
在开始 Fastify 之前，首先需要确保 Node.js 和 npm 已安装。现在，在你的工程目录下新建一个文件夹并使用 npm init 初始化项目，随后使用 npm install fastify --save 安装 Fastify，可以开始编写代码。
----- ------- - -------------------- ---------------- ----- --------- ------ -- - ------ - ------ ------- - -- -------------------- ----- -------- -- - -- ----- ----- --- ------------------- --------- -- ------------ --
首先，我们引入 Fastify 模块，然后创建 Fastify 实例。get 用来设置 HTTP GET 请求，第一个参数为路由路径，第二个参数为处理函数，我们使用 async 函数来处理回调。另外一个参数 routes 是可选的，其中可以定义多个路由。
在路由处理函数中，我们返回一个 JavaScript 对象，这个对象会被自动转成 JSON 格式返回给客户端。最后，我们监听 3000 端口并启动 HTTP 服务器。
配置路由
Fastify 使用一个叫做路由的模块来进行请求的路由。通过解析 URL 控制响应的函数，就像使用 express、koa 等框架一样。Fastify 路由支持 HTTP 常见的请求方法 GET、POST、PUT 等。
--------------------- --------- ---------------------- ----------- ------------------------- -------- ------------------------- ----------- ---------------------------- -----------
我们可以在应用程序中使用 get、post、put、delete 等方法来定义路由，URL 参数也可以使用 /:param 的形式来定义。
在上面的示例中，我们定义了一些路由，它们对应了在用户管理中常见的操作，用户列表、创建用户、获取单个用户、更新用户信息和删除用户。我们需要编写这些路由的响应函数。
快速编写响应函数
在路由的处理函数中，可以处理请求和响应。尤其是通过框架来响应，框架可以自动处理参数的验证、类型转换、错误处理等。下面是一个路由处理函数的例子：
----- -------- ------------------- ------ -
----- - ----- ------ -------- - - ------------
--- -
----- ---- - ----- -------------
-----
------
---------
--
------ -
--- --------
----- ----------
------ -----------
-
- ----- ------- -
-- --- ----- --- ------ ----- -------
------------------------
------------------------ -------- ------------- --
-
-我们使用 request.body 参数解构来获取 POST 请求的数据，使用 User.create() 方法创建一个新用户，然后返回用户的 ID、名称和电子邮件。如果出现错误，我们将记录日志并发送一个错误消息。
配置响应文档
一个良好的 RESTful API 服务，需要清晰且完整的 API 文档，以帮助 API 的使用者清晰的了解 API 的结构及使用方式。而构建和管理 RESTful API 的文档是很麻烦的，Fastify 提供了 fastify-swagger 对于 RESTful API 的文档化提供了非常牛逼的支持。只需安装 fastify-swagger，然后在 Fastify 实例上使用 register 方法即可。
----- ------- - --------------------
----- ------- - --------------------------
----- ---- - -
------------ -----------------
-------- -
----- -
------ --- ------- -----
------------ ----- ------- --- ---- ---------
-------- --------
--
----- -----------------
-------- ---------
--------- ---------------------
--------- ---------------------
--
------------ -----
-
------------------------- ----- --- -- -
-- ----- ----- ---
--fastify-swagger 模块支持 OpenAPI v2 和 v3 格式的文档规范。在上面的代码中，我们创建了一个 Swagger 配置文档。我们定义了标题、描述、版本、主机、协议、消费者和生产者类型，路由前缀设置为 /documentation，最后将文档代理到主应用程序中。
接下来，我们需要在路由函数上上手自定义文档信息。
-- ------ ------------- --- ---- -------- -------
----- ---------------- - -
----- -
----- ---------
----------- -
----- - ----- -------- --
------ - ----- -------- --
--------- - ----- -------- --
--
--------- -------- -------- ------------
--
--------- -
---- -
----- ---------
----------- -
--- - ----- -------- --
----- - ----- -------- --
------ - ----- -------- --
--
--
--
-
---------------------- - ------- ---------------- -- -----------在这个示例中，我们定义了一个 JSON 参数和响应模式。通过定义这些模式，我们可以使用 Swagger UI 显示 API 控制器的文档数据。我们使用 fastify.post() 对 /users 路径进行设置，然后传递一个 schema 选项，这是我们刚刚定义的参数模式。然后传递一个处理方法 createUser。
认证与授权
对于大多数应用程序来说，保护敏感数据以及进行身份验证和授权都是至关重要的。Fastify 对于认证和授权提供了丰富的支持，可以通过插件或中间件的方式来处理。
-- ------ ----- -------------- ------
----- ----------- - -----------------------
-----------------------------
-------------------------------- ----- --------- ------ -- -
--- -
----- -------------------
- ----- ----- -
---------------
-
--
-- ------- -------------- --- ----- --------
--------------------- - -------------- ---------------------- -- ---------在这个示例中，我们使用 fastify-auth 插件来实现基本身份验证。我们使用 fastify.decorate() 为 Fastify 实例添加一个名为 authenticate 的新方法。此方法将验证 JWT 声明并在请求凭据未通过时返回错误响应。
通过使用 beforeHandler 选项可以指定在请求处理函数被调用之前的附加处理程序，比如先进行身份验证。在上面的代码中，我们使用 beforeHandler 选项，在处理 GET /users 路径资源之前，必须经过身份验证。
我们还可以使用其他插件来支持 OAuth、JWT 和其他常见的认证方式。
总结
Fastify 框架是构建高效、高性能 Web 服务的理想选择，其强大的路由和参数验证功能可以帮助我们更加方便、便捷的处理 RESTful API 的请求与响应。而且，我们还可以通过使用 Swagger 等工具来规范化文档，使用身份验证插件可以更好的处理 API 的权限控制。最后，Fastify 框架是一个灵活的 Node.js 框架，可以为我们的 Web 服务提供良好的性能支持，是绝佳的选择。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6521255695b1f8cacd89d389