跳至主要内容

指南

了解如何开始使用 REST API、身份验证以及如何将 REST API 用于各种任务。

本部分文档旨在帮助您使用实际的 GitHub API 应用程序快速上手。我们将介绍您需要了解的所有内容,从身份验证到结果处理,再到将结果与其他应用程序集成。每个教程都将包含一个项目,每个项目都将保存在我们的公开 platform-samples 存储库中并记录在其中。

使用 REST API 和 JavaScript 编写脚本

编写一个使用 Octokit.js SDK 与 REST API 交互的脚本。

使用 REST API 和 Ruby 编写脚本

了解如何编写一个使用 Octokit.rb SDK 与 REST API 交互的脚本。

发现用户的资源

了解如何查找您的应用程序可以访问的存储库和组织,以便对 REST API 的经过身份验证的请求进行可靠访问。

交付部署

使用 Deployments REST API,您可以构建与您的服务器和第三方应用程序交互的自定义工具。

将数据呈现为图表

了解如何使用 D3.js 库和 Ruby Octokit 可视化存储库中的编程语言。

使用评论

使用 REST API,您可以访问和管理您的拉取请求、问题或提交中的评论。

构建 CI 服务器

使用 Status API 构建您自己的 CI 系统。

使用 REST API 与您的 Git 数据库交互

使用 REST API 在 GitHub 上读取和写入原始 Git 对象到您的 Git 数据库,并列出和更新您的引用(分支头和标签)。

使用 REST API 与检查交互

您可以使用 REST API 构建 GitHub 应用程序,针对存储库中的代码更改运行强大的检查。您可以创建执行持续集成、代码检查或代码扫描服务的应用程序,并提供有关提交的详细反馈。

为 REST API 加密机密

为了使用 REST API 创建或更新机密,您必须加密机密的 value。