Postman 使用 GraphQL 查询

2023-04-04 09:23 更新

除了 REST 之外,Postman 还可以使用 GraphQL 进行 HTTP 调用,GraphQL 是一种用于 API 的开源数据查询和操作语言。

您可以通过多种方式使用 Postman 编写和发送 GraphQL 查询:

使用 Postman 对 GraphQL 的内置支持

Postman 内置了对在请求正文中发送 GraphQL 查询使用 GraphQL 变量以及自省和导入 GraphQL 模式的支持。

在请求正文中发送 GraphQL 查询

  1. 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入您的 GraphQL 端点 URL。
  2. POST从请求方法下拉列表中选择。
  3. 在Body选项卡下,选择GraphQL主体类型。
  4. 在查询编辑器中输入您的 GraphQL 查询。该编辑器使您能够分别编写和编辑查询和变量。

选择 GraphQL 主体类型

使用 GraphQL 变量

  1. 在GraphQL 变量编辑器中输入您的 GraphQL 变量。
  2. 在查询编辑器中,在 GraphQL 查询中声明 GraphQL 变量。有关如何使用 GraphQL 变量的更多信息,请参阅GraphQL 变量文档

使用 GraphQL 变量

您还可以使用语法将 Postman 变量用作 GraphQL 变量的数据输入{{variable}}。

自省和导入 GraphQL 模式

要启用自动完成,您的请求需要一个 GraphQL 架构。Postman 将使用 GraphQL 自省自动获取基于请求 URL 的模式。当 Postman 能够自动获取模式时,模式选择列表旁边会显示一条消息。如果您的架构已更改,请选择刷新图标 刷新图标 以引入更改。

GraphQL 自动获取模式

您也可以手动导入模式。当您创建 GraphQL 模式或将其导入Postman 时,您可以选择它而不是自动获取的模式。

要手动导入 GraphQL 架构,请执行以下操作:

  1. 在边栏中选择API ,然后选择+以创建新 API。
  2. 输入 API 的名称和版本。
  3. 从架构类型下拉列表中选择GraphQL。
  4. 从架构格式下拉列表中选择JSON或GraphQL SDL。您可以选择选择“导入”选项卡,直接从本地文件或 GitHub 或 Bitbucket 存储库导入 API 规范。如果您不导入架构,Postman 将使用您可以随时编辑的示例规范填充您的 API。
  5. 选择创建 API。创建一个新的 API
  6. 打开新 API 的版本页面并选择Definition选项卡。在编辑器中输入您的 GraphQL 架构并保存。编辑 API 架构
  7. 返回到您的GraphQL正文。从下拉列表中选择您的架构。您可能需要通过选择刷新图标 进行刷新 刷新图标 。
  8. 开始编辑您的查询。Postman 将从您的新 GraphQL 模式中的数据建议自动完成选项。

GraphQL 自动完成

在请求正文中使用 JSON

  1. 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入您的 GraphQL 端点 URL。
  2. POST从请求方法下拉列表中选择。
  3. 在Headers选项卡中,添加Content-typeof application/json。
  4. 在“身体”选项卡下,选择原始身体类型。从格式下拉列表中选择JSON 。
  5. 使用正确的 JSON 格式在请求正文中构建查询。

GraphQL JSON 请求正文

使用 GraphQL 内容类型标头

  1. 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入您的 GraphQL 端点 URL。
  2. POST从请求方法下拉列表中选择。
  3. 在Headers选项卡中,添加Content-typeof application/graphql。 设置内容类型标头
  4. 在“身体”选项卡下,选择原始身体类型。从格式下拉列表中选择文本。
  5. 使用标准 GraphQL 格式在请求正文中构建查询。

GraphQL 查询请求正文

将查询导入为 cURL 请求

  1. 选择左上角的导入。
  2. 选择原始文本。
  3. 将您的 cURL 命令粘贴到文本字段中,然后继续。您的 cURL 命令必须包含 GraphQL 端点 URL,并且必须指定POST请求方法。 使用 cURL 导入 GraphQL 请求
  4. 选择导入。
  5. 该请求将在新选项卡中打开,其中包含您指定的 GraphQL 端点 URL 和POST请求方法。

GraphQL 响应


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号