如何探索现有的 GraphQL Schema

GraphQL 是一种强类型的查询语言，可以通过定义一个 Schema 来表述数据的类型和关系，然后开发者可以通过 GraphQL API 发送查询语言来获取数据。GraphQL 的优点在于它具有高效、精确的查询、避免了不必要的数据传输以及让客户端能够精确地指定它们需要的数据格式。

在本文中，我们将探索 GraphQL Schema，并了解如何从已有的 GraphQL Schema 中获取有用的信息。我们还将讨论如何使用一些工具来简化探索过程。最后，我们将提供一些最佳实践，以帮助您充分利用现有的 GraphQL Schema。

GraphQL Schema 是什么？

GraphQL Schema 是一组定义了类型、查询、变量和关系的元素，它代表了整个 GraphQL API 的结构。这使得客户端可以了解他们可以查询什么信息，以及如何查询。

GraphQL Schema 通常由三个主要部分构成：Query、Mutation 和 Subscription。Query 用于获取数据，Mutation 用于修改数据，Subscription 用于订阅数据。每个部分都由类型组成，这些类型代表了 GraphQL API 中的不同对象。这些类型通常由标量类型、枚举类型、对象类型、接口类型、联合类型和输入类型组成。

探索一个现有的 GraphQL Schema 可以大大减少我们的工作。我们可以从现有的 GraphQL Schema 中获取信息，包括对象类型、属性/字段、关系和数据类型，而不需要手动查找（代码中可能有许多类型和查询，但我们不一定知道它们在哪里）。下面是一些详细的步骤来探索现有的 GraphQL Schema。

  1. 使用 Introspect 查询：GraphQL 官方规范定义了一个叫做 __schema 的元字段用于检索一个 GraphQL API 的 Schema。它返回一个 JSON 对象，其中包含了类型、查询、变量和关系等信息，您可以通过 Introspect 方式来查看 GraphQL API 的 Schema。

以下是一个 Introspect 查询示例：

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

这个查询将返回一个包含了所有类型名称、描述、该类型包含的字段名称、字段描述，以及每个字段的数据类型和类型分类信息的对象。

  1. 使用 GraphQL IDE 和编辑器插件：现在有许多可用于探索 GraphQL Schema 的 IDE 和编辑器插件。其中一些是 GraphiQL、GraphQL Playground、VS Code 中的 GraphQL 插件、Atom 中的 graphql-autocomplete 插件等。这些 IDE 和插件可以帮助您了解 Schema 中的所有类型和查询，并为您提供自动补全提示和错误检测等功能。

  2. 浏览 GraphQL API 文档：许多 GraphQL API 都提供了相关文档来帮助开发人员了解他们的 Schema。这些文档通常包括了 Schema 中所有的类型、查询、变量和关系。如果您想要快速找到文档，请查看 GraphQL Playground 和 GraphiQL 界面，它们通常会提供如何使用 API 的相关文档。

  3. 观察 Schema 中的字段名称：您可以查看字段的名称来推断实体之间的关系。例如，如果两个实体都有 fieldA，并且它们都是字符串类型，那么我们可以认为这两个实体之间是有关系的。通过这种方式，您可以更好地了解整个 Schema 中各个实体之间的联系。

示例代码

以下是一个简单的 GraphQL Schema，我们将使用它来演示如何从 Schema 中获取信息：

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

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

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

示例代码 1：使用 Introspect 查询

以下是一个 Introspect 查询示例：

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

结果：

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

我们可以看到 __schema 字段返回了所有类型的名称、描述、类型分类（如 SCALER、OBJECT 等）以及该类型包含的字段信息。

示例代码 2：使用 GraphQL Playground 和编辑器插件

如下图所示，当我们在 GraphQL Playground 中输入了书名查询时，我们可以从数据面板中看到请求的响应格式。

图中可以看到：

  • 在左侧面板中，您可以查看整个 Schema 和查询
  • 点击右侧“DOCS”菜单项可以轻松访问Schema和查询文档
  • 在顶部查询面板中，您可以输入你个人的 query
  • 在底部数据面板中，您可以查看查询的结果

示例代码 3：浏览 GraphQL API 文档

您可以在 GraphQL Playground 或 GraphiQL 中打开的页面上找到 GraphQL API 文档。由于每个 GraphQL API 都是不同的，所以文档的呈现形式也可能有所不同。不过，以下是一个通用的 GraphQL API 文档示例（以 GraphQL Playground 为例）：

如上图所示，文档中包括了查询、变量、返回类型和返回类型的描述等信息。在这里，我们可以通过文档快速找到每个查询以及该查询返回的数据类型和关系。

示例代码 4：观察 Schema 中的字段名称

观察每个类型中的字段名称，可以很容易地推断出实体之间的联系。例如，在我们的示例 Schema 中，我们可以认为实体之间是有关系的，因为它们都有名称为 author 的字段。通过所有类型的字段名称，您可以探索整个 Schema 并推断出实体之间的联系。

以下是一个示例查询，它展示了如何使用我们的 Schema 中的 field。

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

使用该查询，我们可以获取所有书籍及其作者，以及每个作者写的所有书籍的标题。该查询的响应如下所示：

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

在这个例子中，我们可以看到 books 这个查询返回了与每个书籍相关的所有信息。实际上，我们这里展示了 GraphQL 探索和查询中的基础知识，如何探索和查询完全取决于您的需求和数据形式。

最佳实践

我们提供以下几个最佳实践，可以帮助您更好地利用现有的 GraphQL Schema：

  1. 经常使用 Introspect 查询：使用 Introspect 查询，可以非常快速、方便地探索 GraphQL Schema。
  2. 阅读 GraphQL API 文档：查看文档更方便掌握 GraphQL Schema。
  3. 使用编辑器插件和 IDE：许多显式的 IDE 和编辑器插件可以帮助您快速查找 Schema 中的信息。
  4. 观察 Schema 中的字段名称：通过字段名称来推断实体之间的联系，这对于理解实体之间关系是非常重要的。
  5. 测试查询和变异操作：许多查询工具允许您测试查询和变异操作，以便您可以确定它们是否按预期工作。

结论

通过探索现有的 GraphQL Schema，我们了解了如何从中提取有用的信息。使用 Introspect 查询、IDE 和编辑器插件，以及 GraphQL API 文档可以极大地减少您的工作，并使您能够快速而准确地了解 GraphQL API 中的任何信息。最后，对于理解 Schema 中实体之间的关系，观察 Schema 中的字段名称非常有帮助。

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

阅读全文

猜你喜欢

  • ES8 异步函数学习笔记

    异步编程是现代 JavaScript 中的一个必备技能，它使得我们能够编写更快、更高效的程序。在早期的 JavaScript 中，异步编程通常使用回调函数来实现。然而，使用回调函数编写异步代码会让代码...

    2 个月前
  • 用 Babel 优化 React 组件性能

    React 是目前最流行的 JavaScript 前端框架之一，但是在复杂的应用程序中，思考如何使组件更高效地渲染是非常重要的。在这篇文章中，我们将介绍如何使用 Babel 来优化 React 组件的...

    3 个月前
  • TypeScript 中如何使用 Mixins

    在 TypeScript 中，Mixins 是一种组合对象的模式，允许一个类从多个类中获得行为。它可以帮助开发者在不需要同时继承多个类或改变原来类继承结构的情况下复用通用代码。

    3 个月前
  • React 常见的错误及其解决方式

    React 是一种流行的 JavaScript 库，它是用于构建用户界面的。它的组件化和单向数据流的模型，使得它非常受欢迎。然而，它也很容易出错。在这篇文章中，我们将探讨 React 中一些常见的错误...

    3 个月前
  • 如何实现 JavaScript 性能优化？

    在 Web 开发中，JavaScript 是不可或缺的一部分。然而，在 JavaScript 的编写过程中，我们必须保证它不仅要正确，还要具有良好的性能。因为浏览器不仅需要解释我们编写的 JavaSc...

    3 个月前
  • PWA 应用中如何优化图片加载速度

    当用户访问 PWA 应用时，快速加载图片是很重要的一环。在许多情况下，这可能是用户体验的瓶颈。本文将介绍一些技术和最佳实践，以提高 PWA 应用的图片加载速度。 1. 替换图片格式 在 PWA 中使用...

    3 个月前
  • 如何解决 Mongoose 中的 CastError 错误

    在使用 Mongoose 进行 MongoDB 数据库操作时，经常会遇到 CastError 错误，这是因为 Mongoose 对数据类型进行了检查，在类型不匹配时会抛出该错误。

    3 个月前
  • MongoDB 查询慢的解决方法

    引言 MongoDB 是一款流行的 NoSQL 数据库，广泛应用于 Web 开发中。但是，有时我们会遇到 MongoDB 查询变慢的问题，这影响了应用程序性能和用户体验。

    3 个月前
  • Kubernetes 集群搭建详解

    简介 Kubernetes 是 Google 开源的容器编排管理平台，它可以帮助开发人员自动化部署、扩展和管理容器化应用程序。Kubernetes 具有高度可扩展性、高可用性、自我修复能力等特点，也是...

    3 个月前
  • Jest 单元测试遇到 Error: Jest: The module factory of `jest.mock()` is not allowed to reference any out-of-scope variables

    Jest 单元测试遇到 Error：Jest：jest.mock() 的模块工厂不允许引用任何超出作用域的变量 Jest 是一个流行的 JavaScript 测试框架，被广泛应用于前端开发。

    3 个月前
  • ESLint 代码规范之道

    在前端开发中，我们经常需要与大量的 Javascript 代码打交道，如何保证这些代码的可读性、可维护性以及可扩展性呢？一个好的代码规范工具就显得尤为重要了。ESLint 就是这样一个著名的代码规范工...

    3 个月前
  • PM2 如何实现进程的监控告警和预警处理

    前言 在前端开发和运维中，我们通常会使用一些进程管理工具来帮助我们管理我们开发的应用程序。PM2 是一个常用的进程管理工具，它可以帮助我们快速启动、停止、重启、监控应用程序，并且提供一些对进程进行监控...

    4 个月前
  • Mongoose 如何使用 $pull 操作符进行数组元素删除操作

    在开发 Web 应用程序时，我们通常会使用 MongoDB 作为我们的数据存储引擎。Mongoose 是一个基于 MongoDB 的 ODM（对象文档映射）库，它提供了一些非常有用的工具来简化数据库操...

    4 个月前
  • Redux 高阶组件（HOC）的应用场景及实现方法

    Redux 是一个 JavaScript 应用程序的状态容器，它可以让我们管理 JavaScript 应用程序的状态并且可以在应用程序的不同部分进行分享与使用。 HOC 是一种 React 的设计模式...

    4 个月前
  • 如何使用 GraphQL 进行图像分析

    随着人工智能和机器学习的发展，图像分析技术正在成为越来越受关注的领域。在前端开发中，我们通常将图像作为页面中的元素，并通过使用 GraphQL 接口来实现图像分析。

    4 个月前
  • Deno 重要代码片段

    简介 Deno 是一个基于 V8 引擎构建的新一代 JavaScript 运行时环境，由 Node.js 的创始人 Ryan Dahl 开发。它的目标是提供一个安全、稳定、高效的运行时环境，支持 Ja...

    4 个月前
  • 如何正确使用 ES11 的可选链操作符 (?.)

    在前端开发中，我们经常需要处理对象的属性和方法，但有时候我们并不确定这些属性和方法是否存在。在这种情况下，我们常常需要编写一些冗长的代码来进行判断和处理。为了解决这个问题，ES11 提供了可选链操作符...

    4 个月前
  • JavaScript 状态机 - ECMAScript 2019 (ES10) - 掘金

    JavaScript 状态机 - ECMAScript 2019 (ES10) 在前端开发中，状态机（State Machine）是一种非常常见的设计模式，它可以帮助我们更好地管理复杂的状态和行为。

    4 个月前
  • Hapi 框架中如何使用 Catbox 实现缓存的完整指南

    随着 Web 应用程序的不断发展，缓存已成为提高性能和可扩展性的重要组成部分。Hapi 是一个流行的 Node.js Web 应用程序框架，而 Catbox 是一个用于缓存的插件。

    4 个月前
  • JavaScript 纯函数详解 - ECMAScript 2019 (ES10) - IT 牛人博客

    JavaScript 纯函数详解 - ECMAScript 2019 (ES10) 在 JavaScript 中，函数是一等公民，它们可以作为参数传递，也可以作为返回值。

    4 个月前

相关推荐

    暂无文章