作为 node.js 的一种 web 框架，Hapi.js 已经成为前端开发人员开发高质量 RESTful API 的首选。在这篇文章中，我们将介绍如何使用 Hapi.js 开发 RESTful API。
什么是 RESTful API
REST 是代表 Representational State Transfer，是一种基于网络协议的架构风格，用于设计 Web 应用程序。RESTful API 属于一种网络架构，是一种使用 HTTP 协议的 API。RESTful API 是基于 REST 架构设计的 API，这些 API 的核心思想是使用 HTTP 方法进行数据操作和资源处理。
RESTful API 的目标是让网络应用程序在各种不同的平台和设备上发送和接收数据都非常简单。为了实现这一点，RESTful API 的设计必须正确实现请求方法，并使用正确的 HTTP 状态码和信息。
Hapi.js 简介
Hapi.js 是一个基于 Node.js 的开源框架，用于构建分布式应用程序和服务。Hapi.js 是一个功能齐全的框架，但同时也是一个易于使用的框架。它提供了丰富的插件和工具，来帮助开发者快速地构建可靠的 RESTful API。
Hapi.js 采用了与 Express.js 不同的路由解析机制，它也是一种高度灵活的框架，可以让开发者更快捷地构建功能齐全的 API。Hapi.js 中的路由定义比 Express.js 更为明确，代码也更加优雅。
如何用 Hapi.js 构建 RESTful API
在开始之前，我们需要安装 Hapi.js 的框架：
npm install hapi
在这里，我将向你介绍如何使用 Hapi.js 来构建基本的 RESTful API。我们将为我们的 API 创建以下端点：
GET /hello //返回“Hello, World!”
现在，让我们看看如何使用 Hapi.js 实现此功能。
-- -------------------- ---- -------
---- --------
----- ---- - ----------------------
----- ---- - ----- -- -- -
----- ------ - -------------
----- -----
----- -----------
---
--------------
------- ------
--------------
-------- --------- -- -- -
------ ------- --------
-
---
----- ---------------
------------------- ------- -- ---- -----------------
--
-------------------------------- ----- -- -
-----------------
----------------
---
-------在这个基础示例中，我们首先引入了 Hapi 模块，然后创建了一个新的服务器示例，并将其配置为在本地主机的端口3000上运行。然后我们中定义了我们的路由，以响应 GET 请求 /hello。最后我们启动了服务器，它绑定到本地主机的端口3000上。
在我们的 API 中，我们只有一个路由，我们使用了 request 和 h 对象来处理 API 请求和返回结果。
路由定义
Hapi.js 的路由规则定义非常简单。创建在端点上监听一个特定的 HTTP 请求类型
server.route({
method: 'GET',
path: '/example',
handler: function (request, h) {
return 'Hello, world!';
}
});Hapi.js 中的每个路由描述定义必须具有以下属性：
- method - HTTP 请求方法，可以是 GET、POST、PUT、DELETE 等等。
- path - 请求 URL 的地址模式。
- handler - 响应请求的处理函数。
handler 函数可以是同步或异步函数。我们可以通过返回 String、Object 或 Buffer 对象或者使用一个 Promise 来定义API路由的请求和响应。
参数的获取
Hapi.js 允许我们在URL和 payload 中获取参数。例如，在下面的 URL 路径中，我们可以获取以下参数：
GET /example?name=rick&status=ok
在路由中，我们可以使用 request.query 对象来获取查询参数。在这个例子中，我们将获取查询参数中的“name”和“status”，如下所示：
exports.handler = function (request, reply) {
const name = encodeURIComponent(request.query.name);
const status = encodeURIComponent(request.query.status);
}Hapi.js 也可以从 request.payload 和 request.params 中获取参数。
-- -------------------- ---- -------
--------------
------- ------
----- ----------------
-------- -------- --------- ------ -
----- -- - --------------------------------------
----- ---- - -----------------------------------------
----- ------ - -------------------------------------------
-
---验证
Hapi.js 也提供了堪比 Express.js 的验证方法：从请求的输入中读取和验证用户数据。
-- -------------------- ---- -------
----- --- - ---------------------
--------------
------- -------
----- -----------
-------- -
--------- -
-------- -
----- -------------------------------
------ -------------------- ------------------ - --
-
-
--
-------- -------- --------- -- -
------ ------------------- --------------------
-
---Joi 是 Hapi.js 的内置模块之一，它用于在请求的数据中进行验证。使用 validate() 方法，Hapi.js 可以自动验证 API 请求中的数据。
在这个例子中，我们创建了一个 POST 路由，并使用 Joi 的验证方法来验证请求的正文。如果正文中的数据不符合规范，就不允许请求。
在路由的选项项中，我们可以指定所需的验证属性。如果停留在选项中，则可以应用于路由的所有方法。
总结
Hapi.js 提供了构建高质量和可靠的 RESTful API 的简单方法和工具。我们已经在这篇文章中介绍了 Hapi.js 的基础知识、路由定义、参数的获取和验证。在掌握了这些知识之后，你可以很容易地开始构建你自己的 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64507492980a9b385b97da19