Skip to main content

Guides

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

文档的这一部分旨在让你使用实际的 GitHub API 应用程序开始运行。 我们将介绍你需要了解的所有内容,从身份验证到结果操作,再到将结果与其他应用集成。 每个教程都将包含一个项目,每个项目都将保存并记录在我们的公共平台示例存储库中。

使用 REST API 和 JavaScript 编写脚本

使用 Octokit.js SDK 编写脚本,以便与 REST API 交互。

使用 REST API 和 Ruby 编写脚本

了解如何使用 Octokit.rb SDK 编写脚本,以便与 REST API 交互。

为用户发现资源

了解如何通过向 REST API 发出经过身份验证的请求,找到您的应用程序能够为用户可靠地访问的仓库和组织。

交付部署

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

将数据渲染为图形

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

处理注释

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

构建 CI 服务器

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

使用 REST API 与 Git 数据库交互

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

使用 REST API 与检查交互

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

加密 REST API 的机密

要使用 REST API 创建或更新机密,必须加密机密的值。