Hapi 是一个 Node.js 框架，用于构建高可伸缩性的 web 应用程序和 API。它提供了一组强大的工具和插件，帮助开发者快速构建应用程序。本文将教你如何使用 Hapi 框架开发可测试的 API。
为什么选择 Hapi
Hapi 已经成为 Node.js 开发中的热门框架。与其他框架相比，Hapi 有许多显著的优点：
- Hapi 具有强大的路由功能，使开发者能够定义非常细致的路由规则。
- Hapi 提供了一组强大的插件和工具，使开发更快速、易于维护。
- Hapi 对于企业级应用尤其适用，支持许多高级功能，如认证、缓存、队列等。
- Hapi 具有出色的测试支持，可以帮助开发者编写可测试的代码。
安装 Hapi
在开始之前，需要确保安装了 Node.js 和 npm。可以通过以下命令安装 Hapi：
npm install --save hapi
编写第一个 API
让我们从一个简单的 API 开始。在项目文件夹中创建一个名为 index.js 的文件，并添加以下代码：
-- -------------------- ---- -------
----- ---- - ----------------
----- ------ - -------------
----- -----
----- -----------
---
--------------
------- ------
----- ----
-------- --------- -- -- -
------ ------ --------
-
---
----- ----- - ----- -- -- -
--- -
----- ---------------
------------------- ------- -- ---------------------
- ----- ----- -
-----------------
----------------
-
--
--------这是一个非常基本的 Hapi 应用程序。在这个应用程序中，我们定义了一个路由规则，它将对根路径发出的 GET 请求进行处理，并返回 "Hello World!" 。我们还启动了一个 Hapi 服务器，并在控制台中打印服务器的 URL。
在终端中输入如下命令，启动服务器：
node index.js
现在访问 http://localhost:3000/ ，应该能看到 "Hello World!" 的文本输出。
API 中的查询参数
对于 API 需要查询参数的情况，可以通过 Hapi 的请求对象来获取这些参数。我们需要获取查询参数 name，并使用其返回一条个性化的信息。在路由处理程序中，我们将通过 request.query 访问查询参数对象。
server.route({
method: 'GET',
path: '/hello',
handler: (request, h) => {
const name = request.query.name || "world";
return `Hello ${name}!`;
}
});在访问 http://localhost:3000/hello?name=John 时，应该能看到 "Hello John!" 的文本输出。
API 中的路由参数
有时，我们可能需要从 API 请求路径中获取某些信息，这些信息对于处理请求非常重要。这就是路由参数的作用。Hapi 允许我们在路由路径中定义参数，以便从处理程序中访问它们。
-- -------------------- ---- -------
--------------
------- ------
----- -------------
-------- --------- -- -- -
----- -- - ------------------
----- ---- - -----------------
------ -----
-
---在上面的示例中，我们定义了一个路由路径 /user/{id}，其中 id 是一个路由参数。在路由处理程序中，我们通过 request.params 访问路由参数对象，并使用 id 查找用户信息。
API 的测试
Hapi 提供了一个强大的测试框架 @hapi/lab，使得编写 API 测试变得非常容易。这个框架提供了丰富的工具和库，使我们能够编写可靠的测试，以确保 API 行为符合预期。
以下是一个简单的测试用例，在测试中我们将测试 /hello 路由返回的值是否正确：
-- -------------------- ---- -------
----- - ------ - - ----------------------
----- --- - ---------------------
----- - ---------- ----------- --------- -- - - ----------- - -------------
----- - ---- - - ------------------------
----------------- -- -- -
--- -------
---------------- -- -- -
------ - ----- -------
---
--------------- -- -- -
----- --------------
---
----------- ----- ------- ----- -- -- -
----- --- - ----- ---------------
------- ------
---- --------
---
----------------------------------- ---------
---
---结论
Hapi 是一个功能强大，易于使用和测试的框架。从本文中，你学会了编写基本的 Hapi API，使用查询参数、路由参数以及编写 Hapi 测试。生产级应用程序要比这个示例复杂得多，但是 Hapi 提供了一组强大的工具和插件，有助于开发者处理常见的 web 开发需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66efcc026fbf96019730e731