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。
- 使用 Introspect 查询：GraphQL 官方规范定义了一个叫做 __schema 的元字段用于检索一个 GraphQL API 的 Schema。它返回一个 JSON 对象，其中包含了类型、查询、变量和关系等信息，您可以通过 Introspect 方式来查看 GraphQL API 的 Schema。
以下是一个 Introspect 查询示例：
-- -------------------- ---- -------
----- ---------------- -
-------- -
----- -
----
-----------
----
------ -
----
-----------
---- -
----
----
-
-
-
-
-这个查询将返回一个包含了所有类型名称、描述、该类型包含的字段名称、字段描述，以及每个字段的数据类型和类型分类信息的对象。
使用 GraphQL IDE 和编辑器插件：现在有许多可用于探索 GraphQL Schema 的 IDE 和编辑器插件。其中一些是 GraphiQL、GraphQL Playground、VS Code 中的 GraphQL 插件、Atom 中的 graphql-autocomplete 插件等。这些 IDE 和插件可以帮助您了解 Schema 中的所有类型和查询，并为您提供自动补全提示和错误检测等功能。
浏览 GraphQL API 文档：许多 GraphQL API 都提供了相关文档来帮助开发人员了解他们的 Schema。这些文档通常包括了 Schema 中所有的类型、查询、变量和关系。如果您想要快速找到文档，请查看 GraphQL Playground 和 GraphiQL 界面，它们通常会提供如何使用 API 的相关文档。
观察 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：
- 经常使用 Introspect 查询：使用 Introspect 查询，可以非常快速、方便地探索 GraphQL Schema。
- 阅读 GraphQL API 文档：查看文档更方便掌握 GraphQL Schema。
- 使用编辑器插件和 IDE：许多显式的 IDE 和编辑器插件可以帮助您快速查找 Schema 中的信息。
- 观察 Schema 中的字段名称：通过字段名称来推断实体之间的联系，这对于理解实体之间关系是非常重要的。
- 测试查询和变异操作：许多查询工具允许您测试查询和变异操作，以便您可以确定它们是否按预期工作。
结论
通过探索现有的 GraphQL Schema，我们了解了如何从中提取有用的信息。使用 Introspect 查询、IDE 和编辑器插件，以及 GraphQL API 文档可以极大地减少您的工作，并使您能够快速而准确地了解 GraphQL API 中的任何信息。最后，对于理解 Schema 中实体之间的关系，观察 Schema 中的字段名称非常有帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66f2587ea44b36ee5765902e