如何探索现有的 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

阅读全文

猜你喜欢

  • SSE 协议在 Ruby on Rails 中实现服务器推送的代码示例

    随着 Web 应用程序的需求日益增长，服务器推送变得越来越普遍，这便是通过 SSE（服务器发送事件）协议来实现的。SSE 是一种基于 HTTP 的协议，允许服务器向浏览器推送事件，使实时更新和实时通信...

    23 天前
  • Enzyme 测试 React 组件渲染的正确方法

    Enzyme 测试 React 组件渲染的正确方法 随着 React 技术的普及，前端开发中越来越多的项目都会选择使用 React。在开发一个 React 组件时，了解如何进行测试是非常重要的。

    23 天前
  • 如何在 Tailwind 中使用 CSS Grid 实现布局

    Tailwind 是一个快速的 CSS 框架，让开发者可以更加快速地开发页面。其中，使用 CSS Grid 实现布局是一种很流行的方式。本文将介绍如何在 Tailwind 中使用 CSS Grid 实...

    23 天前
  • Web Components 中实现更好的事件处理

    随着前端技术的不断发展，Web Components 作为一个组件化的开发模式受到越来越多的关注和使用。在 Web Components 中，如何实现更好的事件处理是一个值得探讨的话题。

    23 天前
  • 实例教程：使用 CSS Grid 制作响应式的博客首页布局

    在 Web 开发中，响应式设计一直是一个非常重要的话题。合适的布局和样式不仅可以提高用户体验，而且可以使网站更加易于访问。CSS Grid 是一个强大的 CSS 布局技术，可以帮助我们实现各种响应式设...

    23 天前
  • 如何使用 MongoDB 进行数据备份和还原

    在开发中，数据备份和还原是非常重要的工作，它可以使我们在数据丢失或系统故障时，更好地保护数据和系统。MongoDB 是一个非常流行的 NoSQL 数据库系统，本文将介绍如何使用 MongoDB 进行数...

    23 天前
  • Promise 与异步操作的应用实例分享

    Promise 与异步操作的应用实例分享 在前端开发中，异步操作是非常常见的需求，比如向后端请求数据、读取本地文件等。我们通常使用回调函数来处理异步操作的结果，但是回调函数在多次嵌套后会产生回调地狱，...

    23 天前
  • ECMAScript 2021 中的 Map.prototype.upsert 方法详解

    ECMAScript（简称 ES）是 JavaScript 编程语言的标准化版本。每年都会发布新版本，其中包含新的语言特性和改进。ES2021（也称为 ES12）是 JavaScript 的最新版本，...

    23 天前
  • Docker 中如何使用 JMeter 进行压力测试

    前言 在前端开发中，经常需要进行性能测试，以确保应用程序能够稳定地运行在高并发环境下。而 JMeter 是一款开源的压力测试工具，可用于测试 Web 应用、Web 服务和任何支持协议的应用程序。

    23 天前
  • 响应式设计中图片压缩优化的技巧

    在现代化的网页设计中，响应式设计已经成为标配。在响应式设计中，图片是网站中不可或缺的一部分，然而，随着屏幕分辨率的增加和视网膜屏的普及，图片文件的尺寸也逐渐增大，导致网站加载缓慢。

    23 天前
  • Node.js 项目中 chai.js 与 mocha.js 的使用实例

    在 Node.js 项目中，测试是一个非常重要的环节。chai.js 和 mocha.js 是两个非常流行的 JavaScript 测试工具。本文将介绍如何使用这两个工具来测试你的 Node.js 项...

    23 天前
  • 使用无障碍标准改善网页可访问性

    随着互联网的发展，网站的访问量越来越大，而这其中不乏一些需要辅助设备才能正常访问的用户，例如视力障碍者、听力障碍者、老年人等。因此，优化网站的可访问性成为了一个迫切的问题。

    23 天前
  • Tailwind 样式设计的最佳实践

    Tailwind 是目前前端开发中最流行的 CSS 框架之一，它通过预设的 CSS 类名实现样式设计。在正确使用的情况下，Tailwind 可以帮助我们快速而且准确地实现样式。

    23 天前
  • Fastify 和 NestJS 比较：选择哪个适合你？

    在当前的前端开发领域中，有许多不同的框架和库可以使用，以帮助你在你的项目中实现各种不同的功能。其中，Fastify 和 NestJS 都是目前非常流行的两个框架之一，它们都可以用来构建高性能的 Web...

    23 天前
  • 性能优化：如何避免延迟问题

    前言 在现代的前端开发中，性能优化是一个非常重要的话题。随着 Web 应用程序变得越来越复杂，前端开发人员需要优化网页加载速度并管理资源，以确保用户能够在最短的时间内访问到所需内容。

    23 天前
  • 用 ESLint 提高您的 React 代码质量

    在前端开发中，代码质量是非常重要的。如果代码不规范、不易维护，会极大的影响项目的开发进度和后期维护。ESLint 是一个开源的代码检查工具，可帮助我们规范化代码，并检查代码中的错误和潜在问题。

    23 天前
  • 解决 Headless CMS 在安全性上的问题

    随着越来越多的公司使用 Headless CMS（无头 CMS）来管理其内容，安全问题变得越来越重要。因为 Headless CMS 是允许从多个渠道访问的，这会使其受到更多的攻击。

    23 天前
  • 解决 Enzyme 测试中的异步问题

    在前端开发中，常常需要进行测试以确保代码的正确性和可靠性。其中，Enzyme 是 React 开发中常用的测试工具之一。但是，当测试中涉及异步操作时，就会出现一些问题。

    23 天前
  • 如何使用 Tailwind CSS 实现响应式导航栏设计

    介绍 在 Web 开发中，导航栏是非常重要的一个组件，它能够为用户提供清晰的网站结构和方便的页面导航。今天，我们将会学习如何使用 Tailwind CSS 框架，来实现一个响应式导航栏设计。

    23 天前
  • 性能优化回顾：8 个问题你不能错过

    作为前端开发者，我们都知道性能优化是至关重要的。但是，我们该如何实现最佳的性能表现呢？本文将介绍八个前端性能优化问题以及对应的解决方案，希望能帮助你提高网站用户体验并加快网站速度。

    23 天前

相关推荐

    暂无文章