REST API 入门

简介

本文介绍如何将GitHub REST API 与GitHub CLI、curl 或 JavaScript 配合使用。 有关快速入门指南，请参阅 GitHub REST API 快速入门。

关于对 REST API 的请求

本节介绍构成 API 请求的元素：

• HTTP 方法
• 路径
• Headers
• 媒体类型
• 身份验证
• 参数

每个对 REST API 的请求都包含一个 HTTP 方法和一个路径。 取决于 REST API 终结点，可能还需要指定请求标头、身份验证信息、查询参数或正文参数。

REST API 参考文档介绍了每个终结点的 HTTP 方法、路径和参数。 它还显示每个终结点的示例请求和响应。 有关详细信息，请查看 REST 参考文档。

HTTP 方法

终结点的 HTTP 方法定义它对给定资源执行的操作类型。 常见的一些 HTTP 方法有 GET、POST、DELETE 和 PATCH。 REST API 参考文档介绍了每个终结点的 HTTP 方法。

例如，“列出存储库问题”终结点的 HTTP 方法为