将 GraphQL 与 HTTP 请求接口结合使用
除了 REST 之外,Postman 还可以使用 GraphQL 进行 HTTP 调用,GraphQL 是一种用于 API 的开源数据查询和操作语言。
你还可以将 GraphQL 与 GraphQL 客户端 一起使用。
你可以通过多种方式使用 Postman 的 HTTP 请求接口编写和发送 GraphQL 查询。
使用 Postman 对 GraphQL 的内置支持
在请求正文中发送 GraphQL 查询
- 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入你的 GraphQL 端点 URL。
POST
从请求方法下拉列表中选择。- 在Body选项卡下,选择GraphQL主体类型。
- 在查询编辑器中输入你的 GraphQL 查询。该编辑器使你能够分别编写和编辑查询和变量。
使用 GraphQL 变量
- 在 GraphQL 变量编辑器中输入你的 GraphQL 变量。
- 在查询编辑器中,在 GraphQL 查询中声明 GraphQL 变量。有关如何使用 GraphQL 变量的更多信息,请参阅 GraphQL 变量文档 。
你还可以 使用语法将 Postman 变量 用作 GraphQL 变量的数据输入
{{variable}}
。
自省和导入 GraphQL 模式
要启用自动完成,你的请求需要一个 GraphQL 模式。Postman 将使用 GraphQL 自省自动获取基于请求 URL 的模式。当 Postman 能够自动获取模式时,模式选择列表旁边会显示一条消息。如果你的架构已更改,请选择刷新图标 以引入更改。
你也可以手动导入架构。当你 创建 GraphQL 模式或将其导入 Postman 时,你可以选择它而不是自动获取的模式。
要手动导入 GraphQL 架构,请执行以下操作:
在边栏中选择API ,然后选择**+**以创建新 API。
输入 API 的名称和版本。
从架构类型下拉列表中选择GraphQL。
从架构格式下拉列表中选择JSON或GraphQL SDL。
你可以选择选择“导入”选项卡,直接从本地文件或 GitHub 或 Bitbucket 存储库导入 API 规范。如果你不导入架构,Postman 将使用你可以随时编辑的示例规范填充你的 API。
选择创建 API。
打开新 API 的版本页面并选择Definition选项卡。在编辑器中输入你的 GraphQL 架构并保存。
返回到你的GraphQL正文。从下拉列表中选择你的模式。你可能需要通过选择刷新图标 进行刷新 。
开始编辑你的查询。Postman 将从你的新 GraphQL 模式中的数据建议自动完成选项。
在请求正文中使用 JSON
- 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入你的 GraphQL 端点 URL。
POST
从请求方法下拉列表中选择。- 在Headers选项卡中,添加
Content-type
ofapplication/json
。 - 在“身体”选项卡下,选择原始身体类型。从格式下拉列表中选择JSON 。
- 使用正确的 JSON 格式在请求正文中构建查询。
使用 GraphQL 内容类型 header
- 在 Postman 中打开一个新的请求选项卡,然后在地址字段中输入你的 GraphQL 端点 URL。
POST
从请求方法下拉列表中选择。- 在Headers选项卡中,添加
Content-type
ofapplication/graphql
。 - 在“身体”选项卡下,选择原始身体类型。从格式下拉列表中选择文本。
- 使用标准 GraphQL 格式在请求正文中构建查询。
将查询导入为 cURL 请求
- 选择左上角的导入。
- 选择原始文本。
- 将你的 cURL 命令粘贴到文本字段中,然后继续。你的 cURL 命令必须包含 GraphQL 端点 URL,并且必须指定
POST
请求方法。 - 选择导入。
- 该请求将在新选项卡中打开,其中包含你指定的 GraphQL 端点 URL 和
POST
请求方法。