警告
GraphQL Explorer 已于 2025 年 11 月 11 日从文档中移除。请参阅我们的更新日志公告。
使用 GraphQL 客户端 IDE
有许多开源的 GraphQL 客户端 IDE,您可以使用它们访问 GitHub 的 GraphQL API。
请参阅 使用 GraphQL 发起调用,了解有关 HTTP 方法、身份验证和 GraphQL 调用结构的详细信息。
首先,选择一个客户端。常见选项包括 GraphiQL、Insomnia 和 Altair(桌面版/网页版/扩展)。您可以在 GraphQL 组织的工具目录 中看到完整的客户端列表。
以下通用说明适用于大多数 GraphQL 客户端
-
将客户端指向 GraphQL 端点:
https://api.github.com/graphql。 -
添加
Authorization头部:Authorization: Bearer TOKEN(将TOKEN替换为您的 GitHub 个人访问令牌。更多信息,请参阅 管理您的个人访问令牌)。 -
将请求方法设置为
POST,或者如果可用,使用客户端提供的 GraphQL 模式。 -
在编辑器中输入查询或变更(mutation),如有需要,在 “Variables” 面板中提供变量。
示例
query { viewer { login } } -
如果您的客户端需要模式(schema)用于文档渲染或自动补全,请通过 GraphQL 自省查询获取。许多客户端可以在 “Docs” 面板中自动完成此操作。
最小自省查询
query IntrospectionQuery { __schema { types { name } } } -
运行请求并检查 JSON 响应。示例中的查询应返回与您所使用的 GitHub 个人访问令牌关联的登录名。
使用客户端 UI 探索文档、运行查询,并根据需要保存请求。
GitHub CLI
您也可以使用 GitHub CLI 命令行运行 GraphQL 查询。
- 安装并使用 GitHub CLI 进行身份验证。
- 使用
gh api子命令,针对https://api.github.com/graphqlGraphQL 端点运行查询。
示例
gh api graphql -f query='query { viewer { login } }'
这将返回与您所使用的 GitHub 个人访问令牌关联的登录名。
请求支持
如有关于 GitHub Apps、OAuth 应用和 API 开发的疑问、错误报告或讨论,请浏览 GitHub 社区讨论中的 API 与 Webhooks 分类。这些讨论由 GitHub 员工进行监督和维护,并由社区成员提供答案。
请考虑直接使用联系表单联系GitHub 支持,以获取
- GitHub 员工的保证回复
- 涉及敏感数据或私人问题的支持请求
- 功能请求
- 关于 GitHub 产品的反馈