Drupal 中的 GraphQL

Drupal 是一款流行的开源内容管理系统,它提供了许多功能强大的模块和主题,帮助用户轻松创建和管理网站。其中一个非常重要的模块就是 GraphQL,它可以让开发人员更加灵活地访问 Drupal 中的数据,并提供了一种简单的方式来构建 API。

什么是 GraphQL?

GraphQL 是一种用于 API 的查询语言,最初由 Facebook 开发。与传统的 RESTful API 不同,GraphQL 通过单个端点提供了一种更加灵活的方式来获取和修改数据。它使用类型系统来定义数据模型,并允许客户端指定需要检索的字段,从而减少了不必要的数据传输,提高了性能。

GraphQL 的查询语言类似于 JSON,但具有更强大的功能和更严格的语法。它支持嵌套查询、变量、别名、分片等特性,可以轻松地处理复杂的数据结构。

Drupal 8 中集成了 GraphQL 模块,可以让开发人员更加方便地使用 GraphQL。它提供了一些默认的查询和突变,包括获取节点、用户、分类、评论等基本数据。同时,也支持自定义查询和突变,可以根据具体需求来进行扩展。

安装和配置

要使用 Drupal 中的 GraphQL,首先需要安装和启用 GraphQL 模块。可以通过 Drupal 的模块管理界面来完成。

在启用 GraphQL 模块后,需要进行一些基本的配置。在 Drupal 的管理界面中,找到“Configuration”->“Web Services”->“GraphQL”,可以看到相关的配置选项。其中最重要的是“Schema”选项,它定义了可以查询的数据类型和字段。默认情况下,GraphQL 模块会自动生成一个基本的 schema,包括节点、用户、分类、评论等基本数据类型。如果需要自定义 schema,可以通过代码或者 UI 来完成。

查询和突变

在 Drupal 的 GraphQL 中,查询和突变都是通过 HTTP POST 请求来执行的。查询使用“query”参数,突变使用“mutation”参数。例如,下面是一个简单的查询,用于获取 Drupal 中的所有文章:

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

这个查询使用了 nodeQuery 查询,它返回了一个包含所有文章节点的数组。其中,每个节点都包含了标题和正文字段。

下面是一个简单的突变,用于创建一个新的文章:

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

这个突变使用了 createArticle 突变,它接受一个包含标题和正文的输入对象。执行成功后,会返回新创建的文章节点的 ID 和标签。

自定义查询和突变

除了默认的查询和突变之外,Drupal 的 GraphQL 还支持自定义查询和突变。可以通过代码或者 UI 来完成。

通过代码定义自定义查询和突变

通过代码定义自定义查询和突变需要编写 PHP 代码。首先需要创建一个类,继承自 \Drupal\graphql\Plugin\GraphQL\Query 或者 \Drupal\graphql\Plugin\GraphQL\Mutation。例如,下面是一个简单的自定义查询,用于获取 Drupal 中的所有用户:

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

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

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

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

-

这个类继承自 QueryPluginBase 类,实现了 resolveValues 方法,用于执行查询。它使用了 Drupal 的 entityQuery API 来获取所有用户的 ID,然后通过 entityTypeManager API 来获取所有用户的实体。

通过 UI 定义自定义查询和突变

通过 UI 定义自定义查询和突变需要使用 Drupal 的管理界面。在“Configuration”->“Web Services”->“GraphQL”->“Schema”选项卡中,可以看到“Queries”和“Mutations”两个选项卡。在这里可以添加、编辑、删除自定义查询和突变。

例如,下面是一个简单的自定义查询,用于获取 Drupal 中的所有用户:

这个查询使用了“allUsers”名称,返回了所有用户的数组。在“Arguments”选项卡中,可以添加查询参数。

示例代码

下面是一个完整的示例代码,用于获取 Drupal 中的所有文章:

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

下面是一个完整的示例代码,用于创建一个新的文章:

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

总结

Drupal 中的 GraphQL 提供了一种简单、灵活、高效的方式来访问和修改数据。它使用了类型系统和强类型语法,可以减少不必要的数据传输,提高性能。同时,它也支持自定义查询和突变,可以根据具体需求来进行扩展。如果你正在使用 Drupal,不妨尝试一下 GraphQL,它可能会让你的开发更加高效。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6630f2afd3423812e4ecdd50