许多 GraphQL 客户端支持通过 introspection 浏览 GraphQL schema。本页将介绍 GraphiQL 和 Altair 客户端。
GraphiQL ↗ 和 Altair ↗ 是开源 GraphQL 客户端,提供编写查询、执行查询并查看结果的工具。此外,它们还支持浏览 GraphQL schema。
开始之前,请务必 配置 API 端点和 HTTP 请求头。
以下截图来自 GraphiQL。不过 Altair 提供相同功能,您可以按照相同步骤探索 schema,不会遇到困难。
要打开 GraphiQL Documentation Explorer,请在响应面板标题中选择 **Docs(文档)**链接:
Documentation Explorer(文档资源管理器) 会打开并显示可用对象列表:
Documentation Explorer(文档资源管理器) 中的对象使用以下语法:
object-name: object-type-definition首次打开 Documentation Explorer(文档资源管理器) 面板时,会显示 mutation 和 query 根类型:
在此示例中,query 是根名称,Query 是类型定义。
点击节点的类型定义可查看其提供的字段。Documentation Explorer(文档资源管理器) 还会显示节点的描述。
例如,选择 Query(查询) 类型定义。Documentation Explorer(文档资源管理器) 会显示 Query 提供的字段。在此示例中,字段为 cost 和 viewer:
要探索 schema,请选择对象和定义的名称。您也可以使用标题中的搜索输入框(放大镜图标)和面包屑链接。
点击 viewer 字段的类型定义(金色文本)可列出其子字段。viewer 字段提供子字段,用于查询 accounts 或 zones 数据:
accounts 和 zones 节点接受参数以指定要查询的数据集。
例如,zones 可以接受 ZoneFilter_InputObject 类型的 filter 作为参数。要查看可用于筛选的字段,请选择 ZoneFilter_InputObject。
要查看可查询的数据集列表,请选择 zone 类型定义(金色文本):
Fields(字段) 部分会显示数据集列表,每个数据集包含有效参数列表和简要描述。以感叹号(!)结尾的参数为必填项。
使用搜索输入框(放大镜图标)查找特定数据集:
要选择数据集,请点击其名称。
随后会显示该数据集的定义。此示例展示 firewallEventsAdaptive 数据集:
要查看特定数据集可用的字段,请点击其类型定义(金色文本)。
例如,选择 ZoneFirewallEventsAdaptive 类型定义可查看 firewallEventsAdaptive 数据集可用的字段:
随后会显示字段列表:
有关 GraphiQL 的更多信息,请参阅本 指南。