跳至主要内容

关于 GraphQL API

GitHub 的 GraphQL API 提供灵活性,并能够精确定义您想获取的数据。

概览

以下是一些快捷链接,帮助您快速开始使用 GraphQL API

欲了解更多关于 GitHub API 的信息,请参阅 GitHub REST API 与 GraphQL API 对比

关于 GraphQL

The GraphQL data query language is

  • 一个 规范 该规范决定 API 服务器上 模式 的有效性。模式决定客户端调用的有效性。

  • 强类型 模式定义了 API 的类型系统及所有对象关系。

  • 可自省 客户端可以查询模式以获取关于模式的详细信息。

  • 层级化 GraphQL 调用的结构映射返回的 JSON 数据结构。嵌套字段 让您在一次请求中查询并仅接收您指定的数据。

  • 一个应用层。 GraphQL 不是存储模型或数据库查询语言。 指的是模式中定义的图结构,其中 节点 定义对象, 定义对象之间的关系。API 根据模式定义遍历并返回应用数据,独立于数据的存储方式。

GitHub 为什么使用 GraphQL

GitHub 选择 GraphQL,因为它为我们的集成者提供了显著更高的灵活性。能够精确定义您想要的数据——且是您想要的数据——相较传统的 REST API 端点具有强大的优势。GraphQL 让您可以用一次调用取代多个 REST 请求,以获取您指定的数据。

欲了解 GitHub 投资 GraphQL 的更多细节,请参阅原始公告博客文章

关于 GraphQL 模式参考

侧边栏中的文档由 GitHub GraphQL 模式生成。所有调用都会根据模式进行验证和执行。使用这些文档可了解您可以调用哪些数据

欲了解其他信息,例如身份验证和速率限制详情,请查看 指南

请求支持

如有关于 GitHub Apps、OAuth 应用以及 API 开发的疑问、Bug 报告或讨论,请浏览 GitHub 社区讨论中的 API 与 Webhooks 分类。这些讨论由 GitHub 员工进行审核和维护,由社区成员提供答案。

考虑直接使用联系表单联系 GitHub 支持,以获取

  • GitHub 员工保证回复
  • 涉及敏感数据或私人问题的支持请求
  • 功能请求
  • 关于 GitHub 产品的反馈

如果您发现意外故障,可以使用 githubstatus.comGitHub 状态 API 来检查是否有影响 API 的事件。

© . This site is unofficial and not affiliated with GitHub, Inc.