GraphQL 是一种用于 API 的查询语言及其运行时环境，可由客户端定义所需的数据结构。相比传统的 RESTful API，GraphQL 具有更灵活、更高效的数据获取方式。Hapi.js 是一种流行的 Node.js 框架，它提供了可扩展的插件、路由以及中间件功能，可用于构建高效、可伸缩性强的 Web 服务器。
在本文中，我们将深入探讨如何使用 Hapi.js 搭建基于 GraphQL 的 API。我们将介绍 Hapi.js 的基本概念和用法，然后详细说明如何使用 GraphQL 在 Hapi.js 中构建 API。最后，我们还将提供完整的示例代码，以便您更好地理解和学习。
Hapi.js 基本概念和用法
在开始使用 Hapi.js 构建 API 之前，让我们先了解一下 Hapi.js 的一些基本概念和用法。
插件
Hapi.js 的插件功能非常强大，可实现各种定制化功能，例如路由、验证器、数据存储方式、缓存等等。在 Hapi.js 中，每个插件都是一个对象，其中包括名称、版本、注册方法等属性。
例如，我们可以使用 Hapi.js 插件 joi 对用户输入进行验证，代码示例如下：
-- -------------------- ---- -------
----- ---- - ----------------------
----- --- - ---------------------
----- ------ - --- -------------
----- -----
----- -----------
---
--------------
------- -------
----- --------
-------- --------- -- -- -
------ ----- ---------
--
-------- -
--------- -
-------- ------------
--------- ---------------------------------------
------ --------------------------------
--------- ------------------------ -----------------------------------------
--
-
-
---
---------------在上面的示例中，我们使用了 joi 插件来验证请求中的 payload 对象是否符合指定的格式。
路由
在 Hapi.js 中，路由指定了 Web 服务器如何响应客户端请求。在路由中，我们可以指定请求的方法、路径、处理函数以及插件等属性。例如，以下代码定义了一个 GET 请求路由：
server.route({
method: 'GET',
path: '/hello',
handler: (request, h) => {
return 'Hello World!';
}
});中间件
中间件是在路由处理函数之前或之后执行的代码片段。Hapi.js 的中间件功能十分灵活，可以方便地实现各种功能，例如身份验证、请求日志记录、数据处理等等。以下是一个例子，使用中间件打印出每个请求的信息：
server.ext('onRequest', (request, h) => {
console.log(`Request received: ${request.method} ${request.url.pathname}`);
return h.continue;
});使用 GraphQL 在 Hapi.js 中构建 API
有了上面的基础知识，我们现在可以开始使用 GraphQL 在 Hapi.js 中构建 API。在继续之前，请确保您已经安装了以下依赖：
@graphql/graphql@hapi/hapi@hapi/good(用于日志记录)
定义 GraphQL Schema
首先，我们需要定义 GraphQL Schema，这是一个描述数据模型和操作的类型定义。在这里，我们定义了一个简单的用户模型，包括 ID、用户名、电子邮件和密码。我们想要提供查询和添加用户的操作。
-- -------------------- ---- ------- ---- ---- - --- --- --------- ------- ------ ------- --------- ------- - ---- ----- - --------- ------- --------------- ----- ----- - ---- -------- - -------------------- -------- ------ -------- --------- --------- ----- -
定义查询和操作
在我们的 GraphQL Schema 中，我们定义了 getUsers、getUserById 和 createUser 三个操作。对于每个操作，我们需要提供解析函数，将其映射到相应的处理程序中。
-- -------------------- ---- -------
----- - -------- ----------- - - ----------------------------
----- ------ - -------------
---- ---- -
--- ---
--------- -------
------ -------
--------- -------
-
---- ----- -
--------- -------
--------------- ----- -----
-
---- -------- -
-------------------- -------- ------ -------- --------- --------- -----
-
---
----- -------- - ----- -- -- -
-- ----- --------- --------
--
----- ----------- - ----- -- -- -- -- -
-- ----- --------- -----------
--
----- ---------- - ----- -- --------- ------ -------- -- -- -
-- ----- --------- ----------
--
----- ---- - -
---------
------------
----------
--创建 Hapi.js 服务器
现在，我们可以使用 Hapi.js 创建 Web 服务器，并将 GraphQL 配置为使用 GraphQL 的解析函数：
-- -------------------- ---- -------
----- - -------- ----------- - - ----------------------------
----- ---- - ----------------------
----- ------ - -------------
---- ---- -
--- ---
--------- -------
------ -------
--------- -------
-
---- ----- -
--------- -------
--------------- ----- -----
-
---- -------- -
-------------------- -------- ------ -------- --------- --------- -----
-
---
----- -------- - ----- -- -- -
-- ----- --------- --------
--
----- ----------- - ----- -- -- -- -- -
-- ----- --------- -----------
--
----- ---------- - ----- -- --------- ------ -------- -- -- -
-- ----- --------- ----------
--
----- ---- - -
---------
------------
----------
--
----- ------ - --- -------------
----- -----
----- -----------
---
--------------
------- -------
----- -----------
-------- ----- --------- -- -- -
----- - ------ --------- - - ----------------
----- ------ - ----- ---------
-------
---------- -----
------------- - ------- --
------- ------
--------------- ---------
---
------ -------
-
---
--------------
------- ------
----- -----------
-------- ----- --------- -- -- -
----- - ------ --------- - - --------------
----- ------ - ----- ---------
-------
---------- -----
------------- - ------- --
------- ------
--------------- ---------
---
------ -------
-
---
---------------在上面的代码中，我们为 POST 和 GET 请求创建了路由，并将 GraphQL 解析函数绑定到路由处理程序中。
集成日志记录
为了方便调试和监控，我们可以将 good 插件集成到 Hapi.js 服务器中，以记录每个请求和响应的信息。
-- -------------------- ---- -------
----- - -------- ----------- - - ----------------------------
----- ---- - ----------------------
----- ---- - ----------------------
----- ------ - -------------
---- ---- -
--- ---
--------- -------
------ -------
--------- -------
-
---- ----- -
--------- -------
--------------- ----- -----
-
---- -------- -
-------------------- -------- ------ -------- --------- --------- -----
-
---
----- -------- - ----- -- -- -
-- ----- --------- --------
--
----- ----------- - ----- -- -- -- -- -
-- ----- --------- -----------
--
----- ---------- - ----- -- --------- ------ -------- -- -- -
-- ----- --------- ----------
--
----- ---- - -
---------
------------
----------
--
----- ------ - --- -------------
----- -----
----- -----------
---
--------------
------- -------
----- -----------
-------- ----- --------- -- -- -
----- - ------ --------- - - ----------------
----- ------ - ----- ---------
-------
---------- -----
------------- - ------- --
------- ------
--------------- ---------
---
------ -------
-
---
--------------
------- ------
----- -----------
-------- ----- --------- -- -- -
----- - ------ --------- - - --------------
----- ------ - ----- ---------
-------
---------- -----
------------- - ------- --
------- ------
--------------- ---------
---
------ -------
-
---
----- -----------------
------- -----
-------- -
---------- -
-------- --
------- ---------------------
----- ----------
----- --
--------- - -------- ------------- --
---- ----
------ ---
--
-- -
------- --------------------
-- ---------
-
-
---
----- ---------------示例代码
完整的代码示例可以在以下 GitHub 存储库中找到：https://github.com/imlinhanchao/hapi-graphql-example
安装依赖
npm install @graphql/graphql @hapi/hapi @hapi/good
运行示例
node index.js
测试 GraphQL API
获取所有用户
{
getUsers {
id
username
email
}
}通过 ID 获取用户
{
getUserById(id: "1") {
id
username
email
}
}创建新用户
mutation {
createUser(username: "user1", email: "user1@example.com", password: "password") {
id
username
email
}
}总结
本文介绍了如何使用 Hapi.js 搭建基于 GraphQL 的 API。我们先介绍了 Hapi.js 的基本概念和用法，然后详细说明了如何使用 GraphQL 在 Hapi.js 中构建 API。我们还提供了完整的示例代码，方便读者学习和实践。使用 GraphQL 和 Hapi.js 可以方便地构建高效、可扩展的 Web API，值得广大前端开发者掌握。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64816f5648841e98940e36af