使用 Hapi.js 搭建基于 GraphQL 的 API

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 请求路由：

--------------
  ------- ------
  ----- ---------
  -------- --------- -- -- -
    ------ ------ --------
  -
---

中间件

中间件是在路由处理函数之前或之后执行的代码片段。Hapi.js 的中间件功能十分灵活，可以方便地实现各种功能，例如身份验证、请求日志记录、数据处理等等。以下是一个例子，使用中间件打印出每个请求的信息：

----------------------- --------- -- -- -
  -------------------- --------- ----------------- --------------------------
  ------ -----------
---

使用 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

安装依赖

--- ------- ---------------- ---------- ----------

运行示例

---- --------

测试 GraphQL API

获取所有用户

-
  -------- -
    --
    --------
    -----
  -
-

通过 ID 获取用户

-
  --------------- ---- -
    --
    --------
    -----
  -
-

创建新用户

-------- -
  -------------------- -------- ------ -------------------- --------- ----------- -
    --
    --------
    -----
  -
-

总结

本文介绍了如何使用 Hapi.js 搭建基于 GraphQL 的 API。我们先介绍了 Hapi.js 的基本概念和用法，然后详细说明了如何使用 GraphQL 在 Hapi.js 中构建 API。我们还提供了完整的示例代码，方便读者学习和实践。使用 GraphQL 和 Hapi.js 可以方便地构建高效、可扩展的 Web API，值得广大前端开发者掌握。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/64816f5648841e98940e36af

阅读全文

猜你喜欢

  • Hapi.js 中的异常处理：如何优雅地处理错误？

    在前端开发中，异常处理是一项很重要的工作。良好的异常处理能够让应用程序更加健壮，提高用户体验，同时也便于代码的维护。Hapi.js 是一种基于 Node.js 平台的 Web 框架，本文将介绍在 Ha...

    1 年前
  • Sequelize 如何对同一个表拆分成多个数据表

    介绍 Sequelize 是一个 Node.js ORM(Object-Relational Mapping) 工具，它可以将关系型数据库映射到对象上，让开发者可以使用面向对象的方式进行数据库操作，而...

    1 年前
  • 在 GraphQL 中处理现实世界中的时间和日期

    GraphQL 是一种用于 API 的查询语言，它使得客户端能够只请求所需的数据，从而减少了无用的数据传输。然而，在 GraphQL 中处理现实世界中的时间和日期可能会有一些挑战，特别是在不同的时区和...

    1 年前
  • Docker 容器部署 Java 应用实践

    前言 在部署 Java 应用程序时，我们普遍采用大型框架，比如 Apache Tomcat、Jetty 等等，这些框架有很多弊端，比如难以管理、配置复杂、部署麻烦等。

    1 年前
  • Serverless 如何实现全局函数？

    在 Serverless 架构中，函数是非常重要且核心的概念。然而，在实际工作中，我们经常需要在多个函数中使用该函数库中的函数，那么怎么样才能在 Serverless 中实现全局函数呢？ 本文将介绍 ...

    1 年前
  • webpack 如何代理解决跨域问题

    随着前后端分离的开发模式越来越流行，跨域问题也变得越来越常见。虽然现代浏览器提供了 CORS（Cross-Origin Resource Sharing）机制来进行跨域访问控制，但在某些情况下，还是需...

    1 年前
  • 如何测试无障碍性？4款实用工具推荐

    随着数字化时代的到来，互联网成为人们获取信息的重要途径。但是，对于一部分有视觉、听觉、运动障碍的人，上网仍然存在很多困难。为了让网站对这部分人更加友好，我们需要关注网站的无障碍性。

    1 年前
  • 不要犯这些 Enzyme 测试的常见错误

    Enzyme 是 React 的一种测试工具，开发人员可以使用它来测试 React 组件的属性、状态等特性。在测试的过程中，我们经常会犯一些常见的错误，这些错误可能会降低测试的效率，甚至有可能导致测试...

    1 年前
  • Chai 报错：AssertionError: expected undefined to be true，如何解决

    如果你经常使用 Chai 进行断言测试，那么在测试过程中可能会遇到如下错误提示： AssertionError: expected undefined to be true 这种错误提示并不太直观...

    1 年前
  • Deno 中的 WebSocket 通信实现方法

    前言 在现代 Web 应用开发中，通过 WebSocket 进行实时通信已经成为一个必要的技术，并且已经在许多场景中得到了广泛的应用。Deno 是一个基于 V8 引擎的新型 TypeScript 运行...

    1 年前
  • ES7 中 Iterable、Iterator、Generator 详解

    在 JavaScript 中，集合是一种重要的数据类型。ES7 提出了 Iterable、Iterator、Generator 三个新概念，使得集合变得更加容易操作和管理。

    1 年前
  • 如何使用 Koa 实现简单的 RESTful API

    Koa 是一个 Node.js 的 web 应用程序框架，它提供了一套优雅的基础开发方法，使得创建 web 应用程序变得更加容易和有趣。使用 Koa 可以方便地实现一个 RESTful API 服务。

    1 年前
  • SASS 中的 @import 语句用法解析

    SASS 是一种 CSS 预处理器语言，它引入了许多有用的特性，使得 CSS 代码更加易于管理和维护。其中，@import 语句是一种非常重要的特性，它可以帮助我们组织和重用代码。

    1 年前
  • 使用 PM2 构建多进程应用程序的最佳实践

    在前端开发中，应用程序的性能和稳定性是至关重要的。而 PM2 是一个支持 Node.js 应用程序的进程管理器，它可以帮助我们构建多进程的应用程序以提升程序的性能和稳定性。

    1 年前
  • CSS Grid 如何实现对话框布局？

    CSS Grid 是一种强大的布局系统，它可以让我们轻松地创建复杂的布局。而对话框是一种常见的 UI 元素，通常用于显示消息、警告或交互窗口。在本文中，我们将探讨如何使用 CSS Grid 实现对话框...

    1 年前
  • 如何在 Node.js 中使用 Socket.io 实现实时聊天？

    Socket.io 是一个能够实现实时、双向、基于事件的通信库，在 Node.js 中被广泛应用于实时聊天、多人协作、实时游戏等场景中。 本文将介绍如何在 Node.js 中使用 Socket.io ...

    1 年前
  • 在使用 Cypress 时如何模拟鼠标和键盘事件

    Cypress 是一个流行的前端自动化测试框架，它允许开发人员轻松地编写和运行端到端测试。在这些测试中，模拟用户输入是必不可少的，因此 Cypress 提供了许多 API 来模拟鼠标、键盘事件和其他交...

    1 年前
  • ES8 标准中 JavaScript 的最新变化和改进

    随着技术的不断发展，JavaScript 也在不断演化，ES8 标准中 JavaScript 的最新变化和改进，为开发者们带来了更加便利和丰富的编程体验。本文将重点介绍 ES8 标准中 JavaScr...

    1 年前
  • Headless CMS 数据备份和恢复方法

    Headless CMS作为一种新兴的网站内容管理系统，与传统的CMS相比，其主要优势在于前后端分离，便于构建现代化单页面应用。然而，Headless CMS也遇到了数据备份和恢复这一非常普遍的问题。

    1 年前
  • React 应用中的错误边界处理

    在 React 应用中，错误边界处理是一种重要的机制，可以让我们在应用出现错误时，优雅地展示错误信息，而不是让整个应用崩溃。本文将介绍 React 中的错误边界处理机制，及其在应用开发中的实践。

    1 年前

相关推荐

    暂无文章