RESTful API 已成为现代 Web 应用程序的标准之一，它提供了一种强大的方式来共享数据和功能。通过使用 Hapi.js 我们能够简化创建完整的、可扩展的、灵活的 RESTful API，并能获得更好的代码组织和管理。
在本篇文章中，我们将详细讨论如何使用 Hapi.js 开发 RESTful API，从请求和路由处理到数据存储和错误处理。我们将提供大量示例代码和实用技巧，以帮助您深入了解如何构建高效、可维护的 RESTful API。
Hapi.js 简介
Hapi.js 是一款为构建 Web 应用程序而设计的 Node.js 框架，它具有强大的路由和插件系统、请求生命周期管理以及对各种数据存储后端的支持。它的特点包括：
- 卓越的插件系统：允许用户轻松地为其应用程序添加新功能和功能扩展。
- 良好的路由系统：允许开发人员定义自定义路由、参数和策略。
- 内置的配置管理：允许在应用程序的不同部分之间共享和重用配置信息。
- 集成的输入验证和数据格式化：使得请求和响应数据更加可控和可预测。
- 良好的错误处理：提供了详细的错误报告和日志，以及对错误处理的支持。
Hapi.js 开发环境搭建
在开始本教程之前，我们需要安装 Node.js 和 npm。在安装完成 Node.js 之后，我们可以使用 npm 命令来完成 Hapi.js 的安装。
npm install hapi
通过这个命令我们将会下载 Hapi.js 并安装它的依赖项。在安装完成之后，我们就可以开始编写代码了。
创建 Hapi.js 应用程序
首先，我们需要创建一个新的 Hapi.js 应用程序。在本教程中，我们将从构建一个简单的 Hello World 应用程序开始，并逐步构建成一个完整的 RESTful API。
我们将创建一个名为 app.js 的文件，并导入 Hapi.js：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------ - ------------- ----- ----- ----- ----------- --- ----- ---- - ----- -- -- - ----- --------------- ------------------- ------- --- --------------------- -- -------------------------------- ----- -- - ----------------- ---------------- --- -------
我们创建了一个新的 Hapi.js 服务器实例，使用它的 start() 方法来启动服务器，并在应用程序中打印出它的 URL。
现在我们已经使用 Hapi.js 构建了一个基本的服务器，让我们通过添加路由来扩展它。
Hapi.js 路由
路由是将传入请求映射到正确的处理程序上的重要因素。在 Hapi.js 中，我们可以使用 server.route() 方法来定义路由。
server.route({
method: 'GET',
path: '/',
handler: (request, h) => {
return 'Hello World!';
}
});在我们编写的代码中，我们创建了一个匹配 GET 请求方法和路径为根路径（即 /）的路由，然后定义了一个名为 handler 的处理程序。
处理程序接受一个 request 对象和一个 h 对象（代表 response toolkit）作为参数，并使用 response toolkit 来向客户端发送响应。在这个例子中，我们只是返回了一个 Hello World! 字符串作为响应消息。
现在，我们使用 curl 命令测试我们的应用程序：
curl http://localhost:3000/
如果一切顺利，您应该能够在终端中看到以下响应：
Hello World!
Hapi.js 请求与响应
在 Hapi.js 中，请求和响应都是 JavaScript 对象，而不仅仅是纯文本内容。这使得我们能够以代码的方式更好的管理请求和响应数据。
请求
在 Hapi.js 中，请求对象包含了客户端的请求信息，如请求URL、请求头、请求负载和请求参数。我们可以在处理程序中访问请求对象的所有信息。
以下是一个获取请求中查询参数的处理程序的示例：
server.route({
method: 'GET',
path: '/',
handler: (request, h) => {
const name = request.query.name || 'World';
return `Hello ${name}!`;
}
});在我们的处理程序中，我们检查了请求中是否存在一个名为 name 的查询参数，如果有，则使用它的值；如果没有，则使用默认值 World。
使用以下命令来测试请求中查询参数功能：
curl http://localhost:3000/?name=John
结果应该是以下响应：
Hello John!
响应
在 Hapi.js 中，响应对象表示对客户端请求的响应，包含内容、HTTP 状态码和响应头。我们可以使用 response toolkit 来构建一个响应，并将它作为返回值返回给客户端。
以下是一个返回响应请求的处理程序的示例：
server.route({
method: 'GET',
path: '/',
handler: (request, h) => {
return h.response('Hello World!').code(200).header('Content-Type', 'text/plain');
}
});在这个处理程序中，我们使用 response toolkit 的 response() 方法创建一个新的响应，使用 code() 方法设置 HTTP 状态码，并使用 header() 方法添加一个响应头。最后，我们将这个响应作为返回值返回给客户端。
以下是一个更高级的处理程序示例，它返回 JSON 数据：
-- -------------------- ---- -------
--------------
------- ------
----- ----
-------- --------- -- -- -
----- ---- - -
----- ----- -----
---- ---
------ -----------------------
--
------ ----------------------------------------------------
-
---在这个示例中，我们创建了一个 JSON 对象，并使用 response() 方法返回它。我们还使用 code() 方法和 type() 方法来设置 HTTP 状态码和 MIME 类型。
在这个处理程序中，我们可以使用以下命令来测试 JSON 数据的返回：
curl -H "Accept: application/json" http://localhost:3000/
结果应该是以下响应：
{"name":"John Doe","age":42,"email":"john.doe@example.com"}Hapi.js 数据存储
在现代 Web 应用程序中，数据存储是不可避免的。在 Hapi.js 中，我们可以使用各种数据库和存储后端，如 MongoDB、Redis、SQLite 等，并通过插件和模块轻松地将它们集成到应用程序中。
MongoDB 的集成
在本教程中，我们将演示如何使用 MongoDB 进行数据存储。为了使用 MongoDB，我们可以使用 hapi-mongodb 插件。请使用以下命令安装它：
npm install @hapi/hapi @hapi/hapi-api mongodb
以下是一个使用 hapi-mongodb 插件的示例：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ------- - -------------------
----- ------ - --- -------------
----- -----
----- -----------
---
-----------------
------- ------------------------------
-------- -
---- ---------------------------------
--------- -
---------------- -----
------------------- ----
--
--------- ----
-
---
--------------
------- ------
----- ----
-------- ----- --------- -- -- -
----- -- - -----------------
----- ---------- - -----------------------
----- ----- - ----- ----------------------------
------ ------
-
---
---------------在这个示例中，我们首先安装了 mongodb 和 @hapi/hapi-mongodb 模块。然后，我们创建了一个新的 Hapi.js 服务器实例，并使用 server.register() 方法将 hapi-mongodb 插件添加到服务器实例中。
插件配置对象中包含了 MongoDB 连接字符串、连接选项和修饰选项。我们可以使用修饰选项为请求对象 request 添加一个新属性 mongo，从而在处理程序中轻松地访问到 MongoDB 数据库。
在我们的路由处理程序中，我们使用 mongo.db 属性来获取到 MongoDB 数据库实例，并选择了一个 users 集合。使用 collection.find() 方法返回所有用户并将其转换为数组。
我们使用以下命令来测试这个示例：
curl http://localhost:3000/
如果连接到 MongoDB 成功，则会返回所有用户的列表。
Hapi.js 错误处理
在 Web 应用程序开发过程中，错误处理是一个关键的部分。准确和用户友好的错误信息可以帮助用户及时找到问题所在。Hapi.js 提供了许多内置的错误处理机制，并给你提供了高度定制错误处理的方式。
错误响应
在 Hapi.js 中，我们可以使用 Boom 插件（一种错误实用程序）来创建、处理和发送 HTTP 错误响应。Boom 提供了一种创建消息字符串的简单方法，从而使错误响应更加友好。
以下是一个使用 Boom 插件的示例：
-- -------------------- ---- -------
----- ---- - ----------------------
--------------
------- ------
----- ----
-------- --------- -- -- -
----- ----- - ------------------------ ------- -------------
------ ------
-
---在这个示例中，我们创建了一个错误响应并使用 badRequest() 方法将它标记为 HTTP 400 BadRequest。我们也可以使用 code() 方法和 output 对象来设置其它的错误状态代码、消息和错误描述。
全局错误处理
在 Hapi.js 中，我们可以使用 server.ext() 方法来处理全局错误。server.ext() 方法可以将处理程序附加到 request、response 或 onPreResponse 响应事件上。
例如，我们可以使用 onPreResponse 事件来全局处理错误并返回友好的错误信息：
-- -------------------- ---- -------
--------------------------- --------- -- -- -
--- -------- - -----------------
-- ----------------- -
----- ------ - ----------------
----- ----- - ---------------
--------------- - --- -------
------ ------------------------------------------
-
------ -----------
---在这个示例中，我们使用 onPreResponse 事件来测试响应是否是错误响应，并在实际的响应对象之前添加一个时间戳。我们把原始的响应状态码和负载信息发送回客户端以保持友好。如果响应不是错误响应，我们继续处理。
结论
在本教程中，我们已经学习了如何使用 Hapi.js 开发 RESTful API。我们讨论了请求和路由处理、数据存储和错误处理，提供了大量示例代码和实用技巧，以帮助您深入了解如何构建高效、可维护的 RESTful API。我们还了解了如何集成 MongoDB、使用 Boom 处理 HTTP 错误响应以及全局错误处理。现在，您可以将所学应用到您的项目中，并进一步扩展它以满足您的需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6749174e93696b02680e61f0