Skip to main content

REST API 简介

熟悉 REST API 文档。

在本文中

可以使用 GitHub's API 生成脚本和应用程序,这些脚本和应用程序可自动执行进程、与 GitHub进程集成和扩展 GitHub。 例如,可使用 API 对问题进行会审、生成分析仪表板或者管理发布。

各个 REST API 端点单独记录,端点按其主要影响的资源分类。 例如,可以在 适用于问题的 REST API 终结点 中找到议题相关终结点。

REST API 入门

如果不熟悉 REST API****,可以参考快速入门或入门指南获取简介。 有关详细信息,请参阅:

如果你熟悉 REST API ,但不熟悉 GitHubREST API,你可能会发现参考身份验证文档会很有帮助。 有关详细信息,请参阅:

如果要生成使用 REST API 的脚本或应用程序****,下列部分指南可能有帮助。 有关使用 REST API 编写脚本的示例,请参阅:

有关便于使用 REST API 编写脚本的库列表,请参阅 REST API 的库

如果要构建使用 REST API 的脚本或应用程序,你可能也有兴趣使用 Webhook 来获取有关事件或代表用户或 GitHub App 组织中的资源访问资源的通知。 有关详细信息,请参阅 关于 网络钩子决定何时生成GitHub应用

其他阅读材料