Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档

关于 GraphQL API

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

概述

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

若要详细了解 GitHub 的 API,请参阅“关于 GitHub 的 API 的信息”。

关于 GraphQL

GraphQL 数据查询语言是:

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

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

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

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

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

GitHub 为什么使用 GraphQL

GitHub 选择 GraphQL,因为它可以为我们的集成商提供明显更高的灵活性。 与传统 REST API 终结点相比,精确定义所需数据且仅定义所需数据的能力是一个强大的优势——。 GraphQL 可用于将多个 REST 请求替换为单个调用,以获取指定的数据。

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

关于 GraphQL 架构引用

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

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

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

请求支持

有关 GitHub Apps、OAuth Apps 和 API 开发的问题、漏洞报告和讨论,请访问 GitHub 社区上的 API 和集成讨论。 该讨论由 GitHub 工作人员管理和维护,但不能保证发布到论坛的问题都会得到 GitHub 工作人员的回复。

请考虑使用联系人表单直接联系 GitHub 支持

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