在当今互联网时代，API 已成为现代应用程序的重要组成部分。为方便开发者开发高质量的 API 接口，Hapi 框架就应运而生。Hapi 是一个 Node.js 框架，它很容易实现 RESTful API 接口，提供了丰富的插件和工具来解决复杂的应用需求。本篇文章将通过详细的讲解及示例代码，分享基于 Hapi 的 API 开发技巧，希望能够帮助读者更好地掌握相关技术。
基础知识
在介绍 Hapi 的 API 开发技巧之前，我们先简单了解下 Hapi 的基础知识。
Hapi 的安装与使用
使用 Node.js 包管理工具 npm 安装 Hapi 的命令为：
npm install hapi
下面是使用 Hapi 框架创建一个简单的服务应用程序的示例代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ------ - --- -------------
----- ------------
----- ----
---
--------------
------- ------
----- ----
---------------- -- -
------ ------- --------
-
---
----- -------- ------- -
--- -
----- ---------------
------------------- ------- --- ---------------------
- ----- ----- -
-----------------
----------------
-
-
--------RESTful API 接口
REST 是 Representational State Transfer 的缩写，即资源的表现层状态转换。REST 是一种基于 HTTP 协议实现的 API 设计风格。它使用 HTTP 方法来定义资源的操作类型，以及通过 URL 地址定位特定资源的 ID。
Hapi 的路由插件可以使用多种 HTTP 方法来定义对资源的基本操作。例如：
-- -------------------- ---- -------
--------------
------- ------
----- -------------
---------------- -- -
----- -- - ------------------
----- ---- - ----------------
------ -----
-
---这里定义了一个 GET 方法，用于获取用户信息。通过 URL 地址的参数传递用户 ID，返回用户的详细信息。
插件
Hapi 以插件的方式来扩展应用程序的功能。官方提供了许多标准化的插件，如 hapi-auth-jwt2、hapi-auth-basic、hapi-boom 和 hapi-swagger 等。开发者还可以自行开发插件来满足应用程序需求。
下面是使用 hapi-auth-jwt2 插件实现 JWT 认证的示例代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- --- - --------------------------
----- ------ - --- -------------
----- ------------
----- ----
---
----- ------------ - ----- --------- -------- -- -- -
-- --------
------ - -------- ---- --
--
------ -- -- -
----- ---------------------
--------------------------- ------ -
---- ------------
--------- -------------
-------------- - ----------- --------- -
---
---------------------------
--------------
------- ------
----- ----
---------------- -- -
------ ------- --------
--
------- -
----- -----
-
---
----- ---------------
------------------- ------- --- ---------------------
-----这里使用 hapi-auth-jwt2 插件实现了 JWT 认证，对于访问 / 的请求会被拦截并验证 token 的有效性。
API 开发技巧
使用 Joi 验证请求参数
Joi 是一个 JavaScript 的对象验证库，它提供了一种简单易用的方式来验证对象的各个属性。在编写 API 接口时，我们通常需要对请求参数进行验证，以确保数据的有效性和完整性。Joi 可以帮助我们轻松实现参数的验证功能。
下面是在 Hapi 中使用 Joi 验证请求参数的示例代码：
-- -------------------- ---- -------
----- --- - ---------------
--------------
------- -------
----- --------
------- -
--------- -
-------- ------------
--------- ------------------------
--------- -----------------------------------------------------------------------
--
-
--
---------------- -- -
----- ------- - ----------------
-- - ------- ------
------ --------
-
---这里使用了 Joi 对 payload 进行了验证，验证规则为必须有 username 和 password 两个值，其中 password 必须由至少8个字符组成的由字母和数字组成的字符串。如果参数不符合要求，Joi 会自动生成详细的验证错误提示信息。
分离业务逻辑
在编写 API 接口时，我们通常需要编写大量的业务逻辑代码。为了避免代码的冗余和混乱不堪，我们可以将业务逻辑代码从控制器中分离出来。通过这种方式，我们可以更好地管理代码结构，提高代码的可维护性和可扩展性。
下面是使用业务逻辑分离技巧实现用户注册功能的示例代码：
userService.js
class UserService {
async create(username, password) {
// 将用户信息保存到数据库
return { username, password };
}
}
module.exports = new UserService();controller.js
-- -------------------- ---- -------
----- ----------- - -------------------------
----- --- - ---------------
-------------- - -
----- --------------- -- -
----- - --------- -------- - - ----------------
-- -------
----- - ----- - - ------------
--------- ------------------------
--------- -----------------------------------------------------------------------
------------- --------- -------- ---
-- ------- -
------ ---------------------------------------
-
-- ------
----- ---- - ----- ---------------------------- ----------
------ -----
-
--userRouter.js
-- -------------------- ---- -------
----- ---------- - ------------------------
-------------- - -
-
------- -------
----- --------
-------- -----------------
-
--这里通过将业务逻辑抽离到单独的 userService.js 文件中，并在 controller.js 文件中调用，将处理请求的逻辑与业务逻辑清晰地分离开来，提高了代码的可读性和可维护性。
使用回调函数和 Promise 控制异步流程
在编写异步 API 接口时，我们通常需要处理异步流程的控制。使用回调函数或 Promise 都是解决异步流程的有效方式。
下面是使用回调函数控制异步流程的示例代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----- - -----------------
----- ------ - --- -------------
----- ------------
----- ----
---
----- ----------- - ---------------------
--------------
------- ------
----- ---------
---------------- -- -
---------------------- ----- ------- -- -
-- ----- -
-----------------
------ ------------ -------- --------- ------ ------ -------------
-
------ -----------------------------
---
-
---
----- -------- ------- -
--- -
----- ---------------
------------------- ------- --- ---------------------
- ----- ----- -
-----------------
----------------
-
-
--------这里使用 Redis 数据库保存数据，并通过 Redis 的 get 方法获取数据。在获取数据时使用 Redis 的回调函数，处理了异步流程的控制。
下面是使用 Promise 控制异步流程的示例代码：
-- -------------------- ---- -------
--------------
------- ------
----- ---------
---------------- -- -
------ --- ----------------- ------- -- -
---------------------- ----- ------- -- -
-- ----- -
-----------------
------------
-
----------------
---
-------------- -- -
------ -----------------------------
------------ -- -
------ ------------ -------- --------- ------ ------ -------------
---
-
---这里使用 Promise 对 Redis 的 get 方法进行了封装。在执行 then 方法的过程中，我们通过 Promise 的 resolve 和 reject 控制异步流程的控制。
使用 Swagger 自动生成 API 文档
Swagger 是一个用于描述 RESTful API 的一种标准格式。通过使用 Swagger，我们可以轻松地生成 API 文档，进一步增强应用程序的可读性和可靠性。虽然 Swagger 可以手动编写，但手动创建 API 文档通常是非常耗时的。我们可以使用 hapi-swagger 插件自动生成 API 文档。
下面是使用 hapi-swagger 插件自动生成 API 文档的示例代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ----------- - ------------------------
----- ---- - ---------------------
----- ------ - --- -------------
----- ------------
----- ----
---
------ -- -- -
----- -------------- - -
----- - ------ ----- --- --------------- -------- ------------ -
--
----- -----------------
- ------- ------------ -------- -------------- -
---
--------------
------- ------
----- ----
---------------- -
------ ------- --------
-
---
----- ---------------
------------------- ------- --- ---------------------
-----在这里，我们在 Swagger 插件中通过参数传递了 API 版本号和标题。在启动应用程序后，我们可以在浏览器中访问 http://localhost:3000/documentation 查看文档页面。
总结
Hapi 是 Node.js 的一种框架，它非常适合用于构建 RESTful API。在本文中，我们展示了一些基于 Hapi 的 API 开发技巧。其中包括使用 Joi 验证请求参数、分离业务逻辑、使用回调函数和 Promise 控制异步流程，以及使用 Swagger 自动生成 API 文档。我们相信这些技巧将对你在实际开发中的工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/646a6a7c968c7c53b0a0cab2