章节目录：

前言

您可以在消息工具和响应器中输入模式的下拉列表中指定输入消息的形式（比如请求、响应、有效负载）。表单 GraphQL 输入模式提供 GraphQL 消息的树状视图，以便您可以在图形界面中构造和查看 GraphQL 消息。此模式是表单输入模式的 GraphQL 版本。

受 SDL 约束的 GraphQL 消息

您可以通过将 GraphQL 消息链接到 SDL，将其约束在 schema 定义中。创建受 SDL 约束的 GraphQL 消息：

  1. 在 SDL 字段中输入 SDL 的 URL 或位置。您还可以点击浏览查找 SDL 文件。
  2. 启用约束 SDL。
  3. 从输入模式下拉菜单中选择表单 GraphQL。

如果已更新 SDL，请返回此页面并点击刷新 SDL 更新 GraphQL 消息的约束条件。

当受到 SDL 约束时，您在根据 schema 构建树时所能使用的元素将受到约束。如何添加取决于元素的类型：

Query、Mutation 与 Subscription

选择顶层节点（ {} ），点击插入 Query、Mutation 或 Subscription 表。

字段

字段可以添加到操作、片段或 SDL 指定的其他字段中。包括字段的操作：

  1. 选择要添加新字段的操作、字段或片段的 SelectionSet。
  2. 启用想要包括的字段。该操作将为字段创建一个新节点。
  3. 选择该字段节点进行编辑。

参数

参数可以添加到字段或指令中。自动包括 SDL 指定的要求参数。可选参数不会自动包括在内。包括可选参数的操作：

  1. 在字段或指令下选择所需的参数节点。
  2. 如果 SDL 显示参数可能为 null，则会提供一个 null 选项。启用后，该值将为 null。禁用后应为参数指定一个非 null 值。
  3. 选择参数节点进行编辑。

参数可以转换为变量。为此，请右键点击所需的参数节点，然后选择切换到变量引用。

指令

指令可按照 SDL 的规定添加到操作、片段、字段或变量中。包括指令的操作：

  1. 选择要添加新指令的操作、片段、字段或变量。
  2. 启用 Directives（如果尚未启用）。该操作将创建一个 Directives 节点。
  3. 选择 Directives 节点并启用您想要包括的指令。该操作将为指令创建一个新节点。如果指令有其他设置，可以选择其节点进行编辑。

变量

变量可以添加到操作中。添加变量操作：

  1. 选择要添加新变量的操作。
  2. 点击 Variables 表下的插入。该操作将创建一个新变量。
  3. 选择变量节点进行编辑。

如需删除字段、参数或指令，请选择其父节点并取消勾选。如需删除变量，请在 Variables 表中选择该变量，然后点击删除。

无约束的 GraphQL 消息

您可以手动构建一个无约束的 GraphQL 消息，或者，如果您有一个可用的 GraphQL 消息，则可以使用它来构建您的表单 GraphQL。为此，请将 GraphQL 信息粘贴到字面量视图中，然后切换到表单 GraphQL 视图。表单 GraphQL 视图将根据提供的值自动填充，并以图形方式显示消息。

您可以从表单视图中添加新的 GraphQL 操作。选择顶层节点（ {} ），点击插入 Query、Mutation 或 Subscription 表。

无论您是将 GraphQL 消息粘贴到字面量视图并将其转换为表单 GraphQL 视图，还是手动添加操作，您都可以在表单视图中添加和删除字段、参数、指令与变量。

字段

字段可以添加到操作或其他字段中。添加字段操作：

  1. 选择要添加新字段的操作或字段。
  2. 启用 SelectionSet（如果尚未启用）。该操作将创建一个 SelectionSet 节点。如果已经启用，请跳至下一步。
  3. 右键点击 SelectionSet 节点，选择插入。
  4. 输入新字段的名称，然后点击 OK。

参数

参数可以添加到字段或指令中。将参数添加到字段的操作：

  1. 选择要添加新参数的字段。
  2. 启用 Arguments（如果尚未启用）。该操作将创建一个 Arguments 节点。如果已经启用，请跳至下一步。
  3. 右键点击 Arguments 节点，选择插入。
  4. 输入新参数的名称，然后点击 OK。

将参数添加到指令的操作：

  1. 右键点击要添加新参数的指令，选择插入。
  2. 在打开的对话框中输入参数名称，然后点击 OK。

指令

指令可以添加到操作、字段或变量中。添加指令操作：

  1. 选择要添加新指令的操作、字段或变量。
  2. 启用 Directives（如果尚未启用）。该操作将创建一个 Directives 节点。如果已经启用，请跳至下一步。
  3. 右键点击 Directives 节点，选择插入。
  4. 输入新指令的名称，然后点击 OK。

变量

变量可以添加到操作中。添加变量操作：

  1. 选择要添加新变量的操作。
  2. 点击 Variables 表下的插入。该操作将创建一个新变量。
  3. 选择变量节点并输入名称和类型。

如需删除字段、参数或指令，请右键点击节点并选择删除。如需删除变量，请在 Variables 表中选择该变量，然后点击删除。

编辑值

您可以使用可用的固定值、参数化、自动和脚本选项在不同的树视图中指定值。

注意，这个视图提供了适用于 GraphQL 的表单输入选项（对相关术语进行更改，例如 null 与 nil）。它包含在数据源中的值填充整个树，生成 CSV 数据源模板、数据源值替换特定元素等。详情请参阅表单输入。

查看字面量 GraphQL

切换到字面量视图将会将表单 GraphQL 的内容应用到字面量视图中。在字面量视图中右键点击 GraphQL 消息可以自动“美化”GraphQL。

  • No labels

Need assistance? Visit our support page