作为一名前端开发者，对于 REST API 的开发，这绝对是我们经常要面对的任务。Hapi 是一个现代化的 Node.js Web 框架，它提供了一整套构建 REST API 的工具以及插件，使我们可以快速地搭建起一套高效的 Web 服务，并且拥有可交互的特性。在本文中，我们将会介绍如何利用 Hapi 框架开发一个可交互的 REST API，并且通过示例代码来演示整个过程。
背景知识
在进行本文内容阅读之前，你需要对以下几个知识点有一定的背景了解：
- Node.js：一款基于 V8 引擎的 JavaScript 运行时环境。
- RESTful API：一种基于 HTTP 协议的架构风格，通过 HTTP 协议进行数据传输。
- Hapi：一个用 Node.js 实现的 Web 框架，提供了一整套构建 REST API 的工具和插件。
开发环境
在进行 Hapi 开发之前，我们需要先准备好开发环境。你需要安装 Node.js（版本 10 以上），并且安装好 npm 包管理器，在此基础上，可以通过以下命令来安装 Hapi：
npm install @hapi/hapi
搭建简单的 Web 服务器
在 Hapi 中，搭建一个简单的 Web 服务器非常容易，只需要几行代码即可完成。下面是一个简单的示例：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ---- - ----- -- -- -
----- ------ - -------------
----- -----
----- -----------
---
--------------
------- ------
---------
-------- --------- -- -- -
------ ------- --------
-
---
----- ---------------
------------------- ------- -- ---- -----------------
--
-------------------------------- ----- -- -
-----------------
----------------
---
-------在上述代码示例中，我们首先引入了 Hapi，然后创建了一个 server 实例，指定了服务器的端口和主机名，接着通过 server.route() 方法来添加了一个接口路由，最后通过 server.start() 启动了服务器，并输出了服务器的地址。在访问 http://localhost:3000/ 地址时，将会输出 Hello, world! 文本。
增加路由
在 API 开发中，我们需要为每个接口定义一个路由。在 Hapi 中，通过 server.route() 方法来配置路由，用法非常简单清晰。下面是一个简单的路由示例：
server.route({
method: 'GET',
path: '/hello/{name}',
handler: (request, h) => {
const name = request.params.name;
return `Hello, ${name}!`;
}
});在上述代码示例中，我们定义了一个 GET 请求方式的路由，路由路径为 /hello/{name}，其中 {name} 表示该路径可以通过变量进行替换。在路由的 handler 回调函数中，我们获取了该路径中的 {name} 变量，并返回 Hello, ${name}! 的文本内容。
参数验证
开发标准的 REST API 时，参数验证是非常重要的一个环节，可以有效地保证 API 的数据安全性。在 Hapi 中，可以使用 @hapi/joi 工具库来实现参数验证。下面是一个参数验证示例：
-- -------------------- ---- -------
----- --- - ---------------------
----- ------------ - ----- --------- -- -- -
----- ------ - ------------
--------- ---------------------------------------
--------- ---------------------------------------
------ -------------------------------
---
----- - --------- --------- ----- - - ----------------
--- -
----- ------------------------------------- - ----------- ----- ---
------ ------- ----------
- ----- ----- -
----- --- ----------------------- -- ------------------ ----
-
--
--------------
------- -------
----- --------
------- -
-------- -------------
--------- -
-------- ------------
--------- ---------------------------------------
--------- ---------------------------------------
------ -------------------------------
--
-
-
---在上述代码示例中，我们首先引入了 @hapi/joi 工具库，接着，通过 Joi.object({}) 方法定义了用户数据的验证规则，并在路由配置中进行了验证。在路由的 config 配置对象中，我们定义了 handler 回调函数，该函数会在参数验证通过之后被调用，否则会抛出一个包含错误信息的异常。
数据持久化
在 REST API 的开发过程中，往往需要进行数据的操作，而数据操作往往要求有一定的持久化机制。在 Hapi 中，可以使用 @hapi/sequelize 工具库来实现数据库操作。下面是一个简单的数据库查询示例：
-- -------------------- ---- -------
----- --------- - ---------------------------
----- --- - --- -----------
-------- ---------
-------- ----------------
--------- -
----------- -----
-
---
----- ---- - ------------------ -
--------- -----------------
--------- -----------------
------ ----------------
---
------------
--------------
------- -------
----- ----
-------- ----- --------- -- -- -
----- - --------- --------- ----- - - ----------------
----- ---- - ----- -------------
---------
---------
-----
---
------ -----
-
---在上述代码示例中，我们首先引入了 @hapi/sequelize 工具库，接着通过 new Sequelize({}) 方法定义了一个简单的 SQLite 数据库，并在 seq.define() 方法中定义了一个 user 表格。在 handler 中，我们通过 User.create() 方法来创建一条用户数据，并返回该数据。
集成 Swagger
Swagger 是一个非常强大的 API 文档生成工具，我们可以使用它来生成 API 的详细文档和交互式测试工具。在 Hapi 中，可以使用 hapi-swagger 插件来简单地集成 Swagger 工具。下面是一个简单的集成 Swagger 的示例：
-- -------------------- ---- -------
----- ----------- - ------------------------
----- ---- - ---------------------
----- -----------------
-
------- ------------
-------- -
----- -
------ ----- --- ---------------
-------- -------------
-
-
--
-- ---
---
--------------
------- ------
----- ----------------
-------- --------- -- -- -
------ ------- -------------------------
--
-------- -
------------ -------- --- ----- ---- ---- - ----------
----- ------- ------------
-------- -
--------------- -
--------- -
------- -----------------------
--
------------ ------
-
-
-
---在上述代码示例中，我们首先通过 require('hapi-swagger') 来引入 hapi-swagger 插件，并在插件的 options 中定义了一些基本配置。在路由的 options 中，我们通过 tags 配置来定义 API 的标签，从而方便查找 API 文档。在 plugins 中，我们通过 hapi-swagger 参数来配置 API 的响应和 Payload 数据类型。
总结
在本文中，我们介绍了如何利用 Hapi 开发可交互的 REST API，并通过几个简单的示例代码来演示了整个过程。在使用 Hapi 进行 API 开发的过程中，需要注意的一点就是 Hapi 框架拥有非常丰富的插件，多数情况下，我们可以很好地从插件库中找到需要的工具和库，从而方便地进行开发。希望通过本文的内容，能够帮助大家更好地了解 Hapi 框架的使用和开发技巧。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/647aea1a968c7c53b068553d