您可以使用 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 应用程序代表用户或组织访问资源。更多信息,请参阅“关于 Webhook”和“何时构建 GitHub 应用程序”。