使用 GraphQL 客户端 IDE
你可以使用许多开放源代码 GraphQL 客户端 IDE 来访问 GitHub 的 GraphQL API。
有关 HTTP 方法、身份验证和 GraphQL 调用结构的详细信息,请参阅“使用 GraphQL 建立调用”。
首先,选择客户端。 常见选项包括 GraphiQL、Insomano 和 Altair(桌面/Web/扩展)。 可在 GraphQL 组织的工具目录中查看客户端的完整列表。
以下通用说明适用于大多数 GraphQL 客户端:
-
将客户端指向 GraphQL 终结点:
http(s)://HOSTNAME/api/graphql
。 -
添加一个
Authorization
标头Authorization: Bearer TOKEN
:(将TOKEN
替换为你的 GitHub personal access token。 有关详细信息,请参阅“管理个人访问令牌”)。 -
将请求方法设置为
POST
或者如果可用,请使用客户端提供的 GraphQL 模式。 -
在编辑器中输入查询或突变,并根据需要在“Variables”面板中提供变量。
示例:
query { viewer { login } }
-
如果客户端需要用于文档渲染或自动完成的架构,可通过 GraphQL 内省查询来获取。 许多客户端都可以从“Docs”面板自动执行此操作。
最小化的内省查询:
query IntrospectionQuery { __schema { types { name } } }
-
运行请求并检查 JSON 响应。 示例中的查询应返回与你用于身份验证的 GitHub personal access token 相关联的登录名。
使用客户端 UI 浏览文档、运行查询并根据需要保存请求。
GitHub CLI
你也可以通过结合使用命令行和 GitHub CLI 来运行 GraphQL 查询。
- 安装并通过 GitHub CLI 进行身份验证。
- 结合使用 GraphQL 终结点和
gh api
子命令运行针对http(s)://HOSTNAME/api/graphql
的查询。
示例:
gh api graphql -f query='query { viewer { login } }'
此操作应返回与你用于身份验证的 GitHub personal access token 相关联的登录名。
请求支持
有关 GitHub Apps、OAuth apps 和 API 开发的问题、漏洞报告和讨论,请访问 GitHub 社区讨论中的 API 和 Webhook 类别。 讨论由 GitHub 工作人员审查和维护,由 GitHub 社区回答。
请考虑使用联系人表单直接联系 GitHub 支持:
- GitHub 工作人员保证响应
- 涉及敏感数据或私人问题的支持请求
- 功能请求
- 关于 GitHub 产品的反馈