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