本节文档旨在帮助您开始使用真实的 GitHub API 应用程序。我们将介绍您需要了解的一切,从身份验证到结果处理,再到将结果与其他应用程序集成。每个教程都将包含一个项目,并且每个项目都将保存在我们公开的 platform-samples 仓库中并进行记录。
指南
了解如何开始使用 REST API、身份验证以及如何将 REST 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 读取和写入 Git 数据库中您的原始 Git 对象,以及列出和更新您的引用(分支头和标签)。
使用 REST API 与检查交互
您可以使用 REST API 构建运行强大检查以应对仓库中代码更改的 GitHub Apps。您可以创建执行持续集成、代码整理或代码扫描服务的应用程序,并提供有关提交的详细反馈。
加密 REST API 的密钥
为了使用 REST API 创建或更新密钥,您必须加密密钥的值。