您可以使用 GitHub 的 API 编写脚本和应用程序,以自动化流程、与 GitHub 集成以及扩展 GitHub。例如,您可以使用该 API 对问题进行分流、构建分析仪表板或管理发行版。
每个 REST API 端点都有单独的文档,并根据其主要影响的资源进行分类。例如,您可以在 REST API 端点(针对问题) 中找到与问题相关的端点。
开始使用 REST API
如果您是 REST API 新手,参考快速入门或入门指南可能会有所帮助。欲了解更多信息,请参阅
如果您熟悉 REST API但对 GitHub 的 REST API 仍不熟悉,参考身份验证文档可能会有所帮助。欲了解更多信息,请参阅
如果您正在构建使用 REST API 的脚本或应用程序,以下指南可能对您有帮助。有关使用 REST API 编写脚本的示例,请参阅
- 使用 REST API 与 JavaScript 编写脚本
- 使用 REST API 与 Ruby 编写脚本
- 构建响应 webhook 事件的 GitHub 应用
- 使用 GitHub 应用构建 CLI
- 自动重新投递仓库 Webhook 的失败投递
有关促进使用 REST API 编写脚本的库列表,请参阅 REST API 库列表。
如果您正在构建使用 REST API 的脚本或应用程序,您可能还对使用 Webhook 以在事件发生时收到通知或使用 GitHub App 代表用户或组织访问资源感兴趣。欲了解更多信息,请参阅 关于 Webhook 和 决定何时构建 GitHub App。