简介
Hapi 是一个优秀的 Node.js Web 开发框架，提供了一系列轻便易用的 API 工具和插件，开发人员可以用 Hapi 快速构建 RESTful API，而且精简的代码和可扩展性也使得 Hapi 逐渐成为 Node.js 开发人员的首选框架之一。
但是，随着 RESTful API 的日益普及，越来越多的项目需要设计和开发 RESTful API，如何设计和实现好 RESTful API 是至关重要的。本文主要讲述 Hapi 框架下 RESTful API 的设计规范及最佳实践。
RESTful API 设计规范
在开始讲解最佳实践前，我们需要明确 RESTful API 的设计规范。简单来说，RESTful API 的设计原则是基于 HTTP 协议的，由以下几个方面来规范：
1. URI
URI 是 Uniform Resource Identifier 的缩写，中文叫做统一资源标识符。在 RESTful API 中，URI 主要用于区分不同的资源，因此需要严格遵守以下规范：
- URI 中只能包含小写字母、数字和短横线（-）。
- URI 应该具有清晰、简明的结构，用斜杠 ( / ) 分隔单词。
- URI 中尽量不应该包含动词和操作，只用名词和名词短语。
例如，获取某个用户信息的 URI 应该为：/users/{userId}
2. HTTP 方法
以下是 HTTP 方法与 RESTful API 资源的对应关系：
- GET：获取资源的详细信息。
- POST：在资源集合中创建新的资源。
- PUT：更新资源。
- DELETE：删除资源。
在 Hapi 框架中，可以通过 server.route 方法为不同的 HTTP 方法指定指定不同 URI 路径的处理程序。
3. HTTP 状态码
HTTP 状态码用于通知客户端，服务端返回的响应的状态。在 RESTful API 中，常用的 HTTP 状态码如下：
- 200：请求成功。
- 201：资源新建成功。
- 204：请求成功，但是无内容返回。
- 400：客户端请求错误（如请求数据格式不正确）。
- 401：无访问权限。
- 404：请求的资源不存在。
- 500：服务端错误。
Hapi 框架下 RESTful API 最佳实践
了解了 RESTful API 设计规范，我们就可以开始在 Hapi 框架下开发 RESTful API，以下是一些最佳实践：
1. 使用 Hapi 路由
在 Hapi 中，可以使用 server.route 方法来定义路由表及其处理程序，其中路由表定义 HTTP 方法、URI 路径和处理程序等信息。使用 Hapi 路由能够方便地定义 RESTful API 的 URI 和 HTTP 方法，遵循 RESTful API 设计规范。
例如，定义获取用户信息的路由：
server.route({
method: 'GET',
path: '/users/{userId}',
handler: getUserInfoById,
});2. 使用 Joi 验证请求参数
在 RESTful API 中，请求参数的校验十分重要，可以最大限度的保护 API 的安全性和稳定性。Hapi 内置了 Joi 校验插件，可以非常方便地对请求参数进行验证。在定义路由时，使用 Joi 插件指定每个请求字段的验证规则，一旦请求参数不符合指定规则，则会自动抛出错误，进行异常处理。
例如，定义用户登录路由时的验证规则：
-- -------------------- ---- -------
----- ----------- - ------------
--------- ------------------------
--------- ------------------------
---
--------------
------- -------
----- ---------
-------- ----------
-------- -
--------- -
-------- ------------
----------- --------- -- ---- -- -
----- ----
--
--
--
---3. 使用 JWT 进行身份验证
RESTful API 的身份验证是十分重要的，常见的身份验证方式有 Cookie、Session 和 Token 等。在 Hapi 中，使用 hapi-auth-jwt2 插件可以非常方便地实现 JWT 身份认证。使用 JWT 身份认证可以提高 API 的安全性，防止篡改和伪造请求。
例如，定义请求头 Bearer Token 认证：
server.route({
method: 'GET',
path: '/auth',
handler: authInfo,
options: {
auth: 'jwt',
},
});4. 合理使用异常处理
RESTful API 的异常处理对于保证 API 的稳定性和性能十分重要。在 Hapi 中，可以使用 try-catch 语句和 Boom 函数等方法来处理异常。合理处理异常可以避免请求超时和服务不可用的情况。在异常处理中，选择合适的 HTTP 状态码也是十分重要的。
例如，定义处理异常的代码：
const someHandler = async (request, h) => {
try {
const result = await something();
return result;
} catch (error) {
return Boom.badRequest(error);
}
};总结
RESTful API 的设计规范和最佳实践对于保证 API 的稳定性和性能非常重要。在 Hapi 框架下，使用 Hapi 路由和 Joi 校验插件等功能，可以快速构建符合规范的 RESTful API。
当然，每个项目的业务逻辑不一样，具体实现过程也会有所差异，以上内容只是提供了 Hapi 框架下 RESTful API 设计规范及最佳实践，供大家参考。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64f2e797f6b2d6eab3c735bc