REST API 简介

熟悉 REST API 文档。

在本文中

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

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

REST API 入门

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

  •         [AUTOTITLE](/rest/quickstart)

  •         [AUTOTITLE](/rest/guides/getting-started-with-the-rest-api)

如果熟悉 REST API**** 但不熟悉 GitHub 的 REST API，参考身份验证文档可能有帮助。 有关详细信息，请参阅：

  •         [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)

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

  •         [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)

  •         [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-ruby)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/building-a-cli-with-a-github-app)

  •         [AUTOTITLE](/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook)

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

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

其他阅读材料

  •         [AUTOTITLE](/rest/overview/comparing-githubs-rest-api-and-graphql-api)

  •         [AUTOTITLE](/rest/guides/best-practices-for-using-the-rest-api)

  •         [AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)

  •         [AUTOTITLE](/rest/overview/troubleshooting-the-rest-api)