跳至主要内容

使用 REST API

了解如何使用 GitHub REST API、遵循最佳实践以及排查问题。

REST API 入门

了解如何使用 GitHub REST API。

REST API 的速率限制

了解 REST API 速率限制、如何避免超出限制以及超出限制时该怎么办。

在 REST API 中使用分页

了解如何浏览 REST API 返回的分页响应。

REST API 的库

您可以使用官方的 Octokit 库和其他第三方库来扩展和简化您使用 GitHub API 的方式。

使用 REST API 的最佳实践

使用 GitHub 的 API 时,请遵循以下最佳实践。

REST API 故障排除

了解如何诊断和解决 REST API 的常见问题。

时区和 REST API

一些 REST API 端点允许您在请求中指定时区信息。

使用 CORS 和 JSONP 发出跨源请求

您可以使用跨源资源共享 (CORS) 和 JSONP 回调跨域发出 API 请求。

问题事件类型

对于问题事件和时间线事件的 REST API,了解每个事件类型、GitHub 上的触发操作以及每个事件的唯一属性。

GitHub 事件类型

对于 GitHub 事件 API,了解每个事件类型、GitHub 上的触发操作以及每个事件的唯一属性。