REST API 入门

要对请求进行身份验证，需要提供具有所需作用域或权限的身份验证令牌。 有几种不同方式获取令牌：可以创建 personal access token，生成包含 GitHub App 的令牌，或使用 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 Enterprise Server 的 REST API 文档，了解可用于与 GitHub Enterprise Server 交互的终结点。

2. 标识终结点的 HTTP 方法和路径。 将随请求一起发送这些内容。 有关详细信息，请参阅 HTTP 方法和路径。

   例如，“创建问题”终结点使用 HTTP 方法和 POST 路径 /repos/{owner}/{repo}/issues。

3. 标识任何必需的路径参数。 必需的路径参数显示在终结点路径的大括号 {} 中。 将每个参数占位符替换为想要的值。 有关详细信息，请参阅 Path。

   例如，“创建问题”终结点使用路径 /repos/{owner}/{repo}/issues，路径参数为 {owner} 和 {repo}。 要在 API 请求中使用此路径，请将 {repo} 替换为想要创建新问题的存储库的名称，并将 {owner} 替换为存储库所有者帐户的名称。

3. 创建身份验证凭据

创建访问令牌对请求进行身份验证。 可以保存令牌并将其用于多个请求。 为令牌提供访问终结点所需的任何作用域或权限。 将会在 Authorization 标头中与请求一起发送此令牌。 有关详细信息，请参阅身份验证。

4. 发出 curl 请求。

使用 curl 命令发出请求。 有关详细信息，请参阅 curl 文档。

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

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

• --url 后跟完整路径作为值。 完整路径是包含 GitHub REST API（http(s)://HOSTNAME/api/v3）的基本 URL 和终结点的路径的 URL，如下所示：http(s)://HOSTNAME/api/v3/PATH。将 HOSTNAME 替换为 你的 GitHub Enterprise Server 实例 的名称。将 PATH 替换为终结点的路径。 有关详细信息，请参阅 Path。

  要使用查询参数，先在路径末尾添加 ?，然后采用 parameter_name=value 形式追加查询参数名称和值。 使用 & 分隔多个查询参数。 如果需要在查询字符串中发送数组，请为每个数组项使用查询参数一次，并在查询参数名称后追加 []。 例如，要提供两个存储库 ID 的数组，请使用 ?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID。 有关详细信息，请参阅查询参数。 有关示例，请参阅使用查询参数的示例请求。

• --header 或 -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 令牌 (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"

使用查询参数的示例请求

“列出公共事件”终结点默认返回 30 个问题。 以下示例使用 per_page 查询参数返回两个问题而不是 30 个，查询参数 page 仅提取结果的第一页。

curl --request GET \
--url "http(s)://HOSTNAME/api/v3/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 "http(s)://HOSTNAME/api/v3/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

使用正文参数的示例请求

以下示例使用创建议题终结点在指定的仓库中创建新的议题。将 HOSTNAME 替换为 你的 GitHub Enterprise Server 实例 的名称。 将 REPO-NAME 替换为想要在其中创建新问题的存储库的名称，并将 REPO-OWNER 替换为存储库所有者帐户的名称。将 YOUR-TOKEN 替换为在上一步中创建的身份验证令牌。

curl \
--request POST \
--url "http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/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 "http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/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 选项。

例如，此请求获取在 中指定的 存储库中的问题列表：

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" \
--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 替换为存储库的名称。将 HOSTNAME 替换为 你的 GitHub Enterprise Server 实例 的名称。

curl --request GET \
--url "http(s)://HOSTNAME/api/v3/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 "http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/issues?per_page=2" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer YOUR-TOKEN" > data.json

然后可以使用 jq 获取每个问题的标题和创建者 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 文档。