Skip to main content

REST API 简介

熟悉 REST API 文档。

在本文中

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

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

REST API 入门

如果不熟悉 REST API,请从快速入门或入门指南开始:

如果你熟悉 REST API ,但 GitHub不熟悉 REST API,请参阅身份验证文档:

如果要生成使用 REST API 的脚本或应用程序,以下指南将有所帮助:

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

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

其他阅读材料