开始使用 REST API

默认情况下，curl 会发送有效的 User-Agent 请求头。不过 GitHub 建议在 User-Agent 请求头的值中使用您的 GitHub 用户名或应用程序名称。这样 GitHub 如有问题可以联系您。

要对请求进行身份验证，您需要提供具有所需作用域或权限的身份验证令牌。有几种获取令牌的方式：可以创建个人访问令牌、通过 GitHub 应用生成令牌，或在 GitHub Actions 工作流中使用内置的 GITHUB_TOKEN。更多信息，请参阅 REST API 身份验证。

有关使用身份验证令牌的请求示例，请参阅 发起请求。

本节演示如何使用 curl 对 GitHub REST API 发起已认证的请求。

1. 设置

您必须在机器上安装 curl。要检查是否已安装 curl，请在命令行运行 curl --version。

• 如果输出中包含 curl 的版本信息，则说明已安装 curl。
• 如果出现类似 command not found: curl 的提示，则说明未安装 curl。请下载并安装 curl。更多信息，请参阅 curl 下载页面。

2. 为请求选择端点

1. 选择一个要请求的端点。您可以浏览 GitHub 的 REST API 文档，发现可用于与 GitHub 交互的端点。

2. 确定该端点的 HTTP 方法和路径。您将在请求中发送这些信息。更多信息，请参阅 HTTP 方法 和 路径。

   例如，“创建 issue”端点使用 HTTP 方法 POST，路径为 /repos/{owner}/{repo}/issues。

3. 识别所有必需的路径参数。必需的路径参数在端点路径中以花括号 {} 显示。请将每个占位符替换为相应的值。更多信息，请参阅 路径。

   例如，“创建 issue”端点的路径为 /repos/{owner}/{repo}/issues，路径参数为 {owner} 和 {repo}。在 API 请求中使用此路径时，请将 {repo} 替换为您希望在其下创建新 issue 的仓库名称，将 {owner} 替换为拥有该仓库的账户名称。

3. 创建身份验证凭据

创建访问令牌以对请求进行身份验证。您可以保存该令牌并在多个请求中使用。为令牌分配访问端点所需的任何作用域或权限。您将在请求的 Authorization 请求头中发送此令牌。更多信息，请参阅 身份验证。

4. 发起 curl 请求

使用 curl 命令发起请求。更多信息，请参阅 curl 文档。

在请求中指定以下选项和值

• --request 或 -X，后跟 HTTP 方法作为值。更多信息，请参阅 HTTP 方法。

• --url，后跟完整路径作为值。完整路径是包含 GitHub REST API 基础 URL (https://api.github.com) 和端点路径的 URL，如：https://api.github.com/PATH。请将 PATH 替换为端点的路径。更多信息，请参阅 路径。

  要使用查询参数，在路径末尾添加 ?，随后以 parameter_name=value 形式添加查询参数。多个查询参数之间使用 & 分隔。如果需要在查询字符串中发送数组，请对数组的每个项目使用一次查询参数，并在参数名称后追加 []。例如，提供两个仓库 ID 的数组，可使用 ?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID。更多信息，请参阅 查询参数。示例请参阅 使用查询参数的示例请求。

• --header or -H

  • Accept: 在 Accept 请求头中传递媒体类型。若要在同一 Accept 请求头中传递多个媒体类型，请用逗号分隔，例如：Accept: application/vnd.github+json,application/vnd.github.diff。更多信息，请参阅 Accept 和 媒体类型。
  • X-GitHub-Api-Version: 在 X-GitHub-Api-Version 请求头中传递 API 版本。更多信息，请参阅 X-GitHub-Api-Version。
  • Authorization: 在 Authorization 请求头中传递您的身份验证令牌。通常情况下，您可以使用 Authorization: Bearer 或 Authorization: token 来传递令牌。然而，如果使用 JSON Web Token (JWT)，必须使用 Authorization: Bearer。更多信息，请参阅 身份验证。使用 Authorization 请求头的请求示例，请参阅 使用请求体参数的示例请求。

• --data 或 -d，后跟以 JSON 对象形式的任意请求体参数。如果请求中不需要指定任何请求体参数，请省略此选项。更多信息，请参阅 请求体参数。示例请参阅 使用请求体参数的示例请求。

示例请求

以下示例请求使用 “获取 Octocat”端点 返回 Octocat 的 ASCII 艺术图。

curl --request GET \
--url "https://api.github.com/octocat" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28"

curl --request GET \
--url "https://api.github.com/octocat" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28"

使用查询参数的示例请求

“列出公共事件”端点默认返回三十个 issue。以下示例使用 per_page 查询参数返回两个 issue，而使用 page 查询参数仅获取第一页的结果。

curl --request GET \
--url "https://api.github.com/events?per_page=2&page=1" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/events

curl --request GET \
--url "https://api.github.com/events?per_page=2&page=1" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/events

使用请求体参数的示例请求

以下示例使用 创建 issue 端点在 octocat/Spoon‑Knife 仓库中创建一个新 issue。请将 YOUR-TOKEN 替换为您在前一步创建的身份验证令牌。

curl \
--request POST \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28" \
--header "Authorization: Bearer YOUR-TOKEN" \
--data '{
  "title": "Created with the REST API",
  "body": "This is a test issue created by the REST API"
}'

curl \
--request POST \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
--header "Accept: application/vnd.github+json" \
--header "X-GitHub-Api-Version: 2022-11-28" \
--header "Authorization: Bearer YOUR-TOKEN" \
--data '{
  "title": "Created with the REST API",
  "body": "This is a test issue created by the REST API"
}'

要查看状态码和请求头，请在发送请求时使用 --include 或 --i 选项。

例如，此请求获取 octocat/Spoon‑Knife 仓库中的 issue 列表

curl --request GET \
--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" \
--include

它会返回类似如下的响应代码和请求头

HTTP/2 200
server: GitHub.com
date: Thu, 04 Aug 2022 20:07:51 GMT
content-type: application/json; charset=utf-8
cache-control: public, max-age=60, s-maxage=60
vary: Accept, Accept-Encoding, Accept, X-Requested-With
etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18"
x-github-media-type: github.v3; format=json
link: <https://api.github.com/repositories/1300192/issues?per_page=2&sort=updated&direction=asc&page=2>; rel="next", <https://api.github.com/repositories/1300192/issues?per_page=2&sort=updated&direction=asc&page=7409>; rel="last"
access-control-expose-headers: ETag, Link, Location, Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
x-ratelimit-limit: 15000
x-ratelimit-remaining: 14996
x-ratelimit-reset: 1659645535
x-ratelimit-resource: core
x-ratelimit-used: 4
accept-ranges: bytes
content-length: 4936
x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715

在此示例中，响应代码为 200，表示请求成功。

例如，您可以使用 > 将响应重定向到文件。以下示例中，请将 REPO-OWNER 替换为拥有该仓库的账户名称，将 REPO-NAME 替换为仓库名称。

curl --request GET \
--url "https://api.github.com/repos/REPO-OWNER/REPO-NAME/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" > data.json

curl --request GET \
--url "https://api.github.com/repos/REPO-OWNER/REPO-NAME/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" > data.json

然后您可以使用 jq 获取每个 issue 的标题和作者 ID

jq '.[] | {title: .title, authorID: .user.id}' data.json

jq '.[] | {title: .title, authorID: .user.id}' data.json

前两个命令的返回结果类似于

{
  "title": "Update index.html",
  "authorID": 10701255
}
{
  "title": "Edit index file",
  "authorID": 53709285
}

有关 jq 的更多信息，请参阅 jq 文档。