Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

关于 GraphQL API

GitHub GraphQL API 具有灵活性,而且能够准确定义您要获取的数据。

概览

下面是一些帮助您启动和运行 GraphQL API 的快速链接:

关于 GraphQL

GraphQL 数据查询语言为:

  • 规范此规范可确定 API 服务器上架构的有效性。 架构可确定客户端调用的有效性。

  • 强类型化架构可定义 API 的类型系统和所有对象关系。

  • 内省客户端可查询架构,了解关于架构的详细信息。

  • 层次GraphQL 调用的形式可反� 它返回的 JSON 数据的形式。 嵌套字段可用于仅查询和接收您在单个往返向行程中指定的数据。

  • 应用层。GraphQL 不是存储模型或数据库查询语言。 graph 是指架构中定义的图形结构,其中,节点定义对象,边缘定义对象之间的关系。 API 可以� �据架构定义遍历和返回应用数据,与数据的存储方式� 关。

GitHub 为什么使用 GraphQL

GitHub 选择 GraphQL,� 为它可以为我们的集成商提供明显更高的灵活性。 准确定义所需数据—仅仅是您所需的数据—的能力是它超越� 统 REST API 端点的强大优势。 GraphQL 可用于将多个 REST 请求替换为单个调用,以获取您指定的数据。

有关 GitHub 为什么投资 GraphQL 的详细信息,请参阅原始公告博客文� 

关于 GraphQL 架构引用

边� �中的文档是从 GitHub GraphQL 架构 生成的。 所有调用均� �据架构验证和执行。 使用这些文档查找您可以调用的数据:

您可以通过 Explorer 文档边� �访问同� �的内容。 请注意,您可能需要依� 文档和架构验证才能成功调用 GraphQL API。

有关其他信息,如身份验证和速率限制详细信息,请查看指南

请求支持

有关 GitHub 应用程序、OAuth 应用程序 和 API 开发的问题、漏洞报告和讨论,请访问 GitHub API 开发和支持论坛。 该论坛由 GitHub 工作人员管理和维护,但不能保证发布到论坛的问题都会得到 GitHub 工作人员的回复。

对于以下问题,请考虑使用联系表直接联系 GitHub Support

  • 要保证得到 GitHub Enterprise Server 工作人员的回应
  • 涉及敏感数据或私人问题的支持请求
  • 功能请求
  • 关于 GitHub Enterprise Server 产品的反馈