如何在 VS Code 中测试 GraphQL API
本页内容 6 个小节
简短回答:GraphQL 请求就是一个 HTTP POST,其 JSON 请求体包含查询、变量,以及可选的操作名。任何支持 GraphQL 的 REST 客户端都可以发送它。本指南使用 DevSnip Pro 中免费的 REST API 客户端,它有一个 GraphQL 模式,为查询、变量和操作名提供了独立的字段。
- 在命令面板(Ctrl/Cmd+Shift+P)中运行 DevSnip Pro: REST API Client。
- 将协议从 HTTP 切换为 GraphQL(位于请求名称旁边)。Body 标签页会被 Query 标签页取代。
- 将方法设为 POST,并输入端点,例如
https:/(一个公开的演示 API)或/ countries. trevorblades. com/ {{baseUrl}}/。graphql
如果方法是 GET,客户端会提醒查询不会被发送,并提供 Use POST 选项。
在 Query 字段中:
query GetCountry($code: ID!) {
country(code: $code) {
name
capital
currency
}
}在 Variables (JSON) 中:
{ "code": "DE" }变量字段会在你输入时进行检查,因此无效的 JSON 会在发送前被标出。当文档包含多个操作时,请填写 Operation name(GetCountry)。
按 Ctrl/Cmd+Enter 或点击 Send。即使查询失败,GraphQL 服务器通常也会返回 200 OK,所以请查看响应体:
data包含结果;errors列出问题,包括消息和路径。响应可能同时包含两者,这表示只返回了部分结果。
GraphQL API 使用与 REST API 相同的认证方式。把令牌放到环境变量中,并将 Bearer 认证设为 {{token}};切换环境,即可对本地和预发布环境运行同一个查询。把请求保存到集合中,这个查询就成了文档。
从工具侧边栏的 Backend & API 分区打开 GraphQL Formatter & Types:
- Query: format & request 可以格式化或压缩查询,列出其中的操作和变量,并生成 JSON 请求体、cURL 命令和
fetch调用。它还会标出未定义或未使用的片段以及未命名的操作。 - Schema (SDL) → TypeScript 可将 Schema 转换为 TypeScript 类型。如需完全带类型的操作,GraphQL Code Generator 能做得更多。
- 没有 Schema 浏览器,也没有基于内省的自动补全;请自己编写查询,或从代码库中粘贴。
- 基于 WebSocket 的 GraphQL 订阅没有专门的模式。客户端的 WebSocket 工具是需要积分的高级功能。