跳到主要内容

使用 GraphQL 客户端接口

Postman 中的 GraphQL 请求包括各种工具、视图和控件，可帮助你有效且高效地调试和记录你的 GraphQL API。本文档重点介绍了请求接口和响应的部分，并解释了如何使用它们。

GraphQL 请求的不同部分

创建新请求​

你可以从 Postman 主屏幕创建一个新的 GraphQL 请求，方法是使用New > GraphQL，或选择+打开一个新选项卡。 +打开一个新标签。

创建一个新的 GraphQL 请求

选择保存以创建你的请求。

加载 GraphQL 模式​

你可以在请求中使用 GraphQL 模式来浏览可用的数据字段。这使得创建查询更加容易。Postman 使你能够使用 GraphQL 自省加载 GraphQL 模式。这是直接从服务器获取模式的最简单方法。当你输入 URL 时，Postman 会自动加载架构。

将模式添加到请求

你还可以选择 从 Postman 加载 GraphQL API 或从本地系统 导入架构以在请求中使用。

了解请求接口的各个部分​

请求接口使你能够添加配置以连接到服务器并执行查询。你可以定义 URL、加载架构、构建查询并选择查询来执行它。根据 API 要求，你可能还需要随查询一起传递授权详细信息、其他元数据和设置。

请求接口的不同部分

  • URL - 定义托管服务的端点。在创建新请求时，你还可以通过选择URL字段来浏览你使用过的 URL。如果你要对同一点执行不同的查询，这可以帮助你更快地创建请求。
  • 查询按钮- 一旦你定义了 URL 并构建了查询，你就可以选择查询来执行它。执行查询后，服务器会发回包含请求数据的响应。
  • 保存按钮- 将请求保存到一个集合中，以便你以后可以重用它或记录下来并与他人共享。
  • 查询-查询选项卡包含三个子部分：查询浏览器、查询编辑器和变量部分。
    • 查询资源管理器- 加载模式后，可用数据字段、要传递的参数及其各自的描述将出现在该部分中。模式查询还兼作交互式可视化查询编辑器，使你能够选择各个字段和参数来构建查询。
    • 查询编辑器- 在此处构建和编辑你的查询、变更、片段和订阅。
    • 变量- GraphQL 使你能够将变量作为参数传递给客户端中动态定义的值。你可以在查询中使用这些变量，并使用“变量”部分分别定义它们的值。
  • 授权- 你可以在**授权**选项卡下输入授权凭据。你可以从包括 API Key、Basic auth 和 Bearer token 在内的授权类型列表中进行选择。详细了解 授权请求 。
  • header-header选项卡以键值对的形式随请求传递附加 header。客户端使用这些 header 来提供有关对服务器的调用的更多信息。
  • Schema - Schema选项卡允许你配置 GraphQL schema 以使客户端知道服务器可用的数据字段。可以通过内省使用 URL 直接加载 GraphQL 模式。你还可以使用同一工作空间中的 GraphQL API 或从本地系统导入 GraphQL 模式。
  • 脚本-脚本选项卡访问 Postman 强大的脚本环境，使你能够在 GraphQL 请求中添加 JavaScript 代码（脚本）。你可以使用脚本编写 API 测试，通过登录到 Postman 控制台来调试你的请求，或者动态读取或更新 变量 的值。

了解响应​

当你执行查询时，来自服务器的响应会出现在响应区域中。

响应界面的不同部分

对于单个响应，响应部分包含以下项目：

  • 正文- 此选项卡显示服务器为查询中提到的字段返回的数据。
  • 换行按钮- 选择此按钮可根据响应区域的宽度调整响应主体的宽度，从而无需水平滚动即可更轻松地阅读更宽的响应。
  • 搜索- 使用**“搜索”**按钮在响应中查找特定元素。
  • header- 此选项卡显示服务器返回的 header，通常包含有关执行的附加信息。
  • 测试结果- 此选项卡显示你在脚本部分编写的断言的结果。根据测试脚本，结果可以是以下三种类型之一：通过、失败或跳过。

多重回应​

在执行通过持久连接返回多个响应的订阅类型查询时，响应区域将这些响应显示为流。

响应流的不同部分

  • 消息流- 消息流具有按时间倒序排列的请求和响应消息（最新出现在顶部）。
  • 展开/折叠响应- 你可以通过在响应流中展开响应内容来深入查看响应内容。
  • 搜索消息- 你可以使用高级搜索输入来搜索特定消息。
  • 过滤器- 使用消息过滤器根据消息类型调整视图。你可以选择“所有消息”、“回复”或“其他”。
  • Clear Messages - 隐藏视图中交换的所有消息，清理响应区域，以便你可以专注于新消息。你可以在清除消息后使用恢复按钮恢复消息。

创建和执行多个查询​

GraphQL 请求接口使你能够创建多个查询并一次执行一个。你可以在查询资源管理器中选中一个复选框，然后选择“查询”以仅执行选定的查询。

使用查询资源管理器发送单个查询

你还可以使用“查询”按钮下拉菜单来浏览和选择查询。

使用查询按钮发送多个查询

右侧边栏使你可以访问工具和信息，例如文档、评论和请求详细信息。打开 GraphQL 请求并在右侧栏中选择一个选项：

下一步​

了解基本界面元素后，尝试 进行你的第一个 GraphQL 查询 。