GitHub调用手册
查询待处理拉取请求
列出仓库打开中的拉取请求,用于评审看板和变更提醒。
← 返回平台功能接入准备
- 私有仓库需令牌覆盖目标仓库,Pull requests: Read;公开数据可匿名读取。
准备环境变量
示例值需要替换为自己的凭证或资源 ID。代码在本机或服务端运行;密钥不应放进公开网页。
GITHUB_TOKEN- 在 GitHub Settings → Developer settings → Personal access tokens → Fine-grained tokens 创建,仅在本地或服务器设置。
GITHUB_OWNER- 仓库 URL 中 github.com/ 后的账号或组织名;虚构值,请替换。
GITHUB_REPO- 仓库 URL 中第二段名称,不含 .git;虚构值,请替换。
export GITHUB_TOKEN='github_pat_replace_with_your_token'
export GITHUB_OWNER='example-owner'
export GITHUB_REPO='example-repo'以上 export 适用于 macOS / Linux 的终端,在同一终端内运行后续代码。Python 示例保存为 request.py 后执行 python3 request.py。
调用步骤
- 01
打开 GitHub 头像 → Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate new token,填写用途和到期时间。
- 02
Resource owner 选择仓库所属个人或组织;Repository access 仅选需要接入的仓库。
- 03
Repository permissions 设置 Pull requests: Read-only。组织要求审批时,等待管理员批准后再读取私有资源。
- 04
生成后复制令牌到 GITHUB_TOKEN;从仓库 URL 提取 GITHUB_OWNER 与 GITHUB_REPO。不要把令牌放进网页源码。
调用 01
列出打开的拉取请求
示例按更新时间倒序取第一页,不会修改或合并任何代码。
GET
https://api.github.com/repos/${GITHUB_OWNER}/${GITHUB_REPO}/pulls?state=open&sort=updated&direction=desc&per_page=30&page=1请求头
Acceptapplication/vnd.github+jsonAuthorizationBearer ${GITHUB_TOKEN}X-GitHub-Api-Version2026-03-10
参数说明
参数表可左右滑动,查看完整说明。
| 字段 / 位置 | 类型 / 必填 | 说明 |
|---|---|---|
stateQuery | string可选 | open、closed 或 all;本例 open。 |
sort / directionQuery | string可选 | 本例 updated 与 desc,最近更新在前。 |
per_pageQuery | integer可选 | 每页最多 100,默认 30。 |
pageQuery | integer可选 | 页码从 1 开始;后续按 Link 响应头翻页。 |
调用代码
替换示例 ID 与请求体内容后运行。cURL 会报 HTTP 错误,业务状态还需按下方返回示例核对。
# 执行后核对返回 JSON 的业务状态;HTTP 200 仍可能包含业务错误。
curl --silent --show-error --fail-with-body \
--request GET \
--url "https://api.github.com/repos/${GITHUB_OWNER}/${GITHUB_REPO}/pulls?state=open&sort=updated&direction=desc&per_page=30&page=1" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer ${GITHUB_TOKEN}" \
--header "X-GitHub-Api-Version: 2026-03-10"
import json
import os
import re
import urllib.request
import urllib.error
def expand(value):
return re.sub(r"\$\{([A-Z][A-Z0-9_]*)\}",
lambda match: os.environ[match.group(1)], value)
url = expand("https://api.github.com/repos/${GITHUB_OWNER}/${GITHUB_REPO}/pulls?state=open&sort=updated&direction=desc&per_page=30&page=1")
headers = {
"Accept": expand("application/vnd.github+json"),
"Authorization": expand("Bearer ${GITHUB_TOKEN}"),
"X-GitHub-Api-Version": expand("2026-03-10"),
}
data = None
request = urllib.request.Request(url, data=data, headers=headers, method="GET")
try:
with urllib.request.urlopen(request, timeout=30) as response:
result = json.load(response)
except urllib.error.HTTPError as error:
print(f"HTTP {error.code}: {error.read().decode('utf-8', errors='replace')}")
raise SystemExit(1)
print(json.dumps(result, ensure_ascii=False, indent=2))
// Node.js 22+,保存为 request.mjs 后运行 node request.mjs
function expand(value) {
return value.replace(/\$\{([A-Z][A-Z0-9_]*)\}/g, (_, name) => {
if (!process.env[name]) throw new Error(`缺少环境变量 ${name}`);
return process.env[name];
});
}
const url = expand("https://api.github.com/repos/${GITHUB_OWNER}/${GITHUB_REPO}/pulls?state=open&sort=updated&direction=desc&per_page=30&page=1");
const headers = Object.fromEntries(
Object.entries({
"Accept": "application/vnd.github+json",
"Authorization": "Bearer ${GITHUB_TOKEN}",
"X-GitHub-Api-Version": "2026-03-10"
}).map(([key, value]) => [key, expand(value)])
);
const response = await fetch(url, {
method: "GET",
headers,
signal: AbortSignal.timeout(30000),
});
const text = await response.text();
if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
const result = JSON.parse(text);
console.log(JSON.stringify(result, null, 2));
返回示例
按官方字段整理的响应结构示意,ID、文本和数字均为虚构,非接口实测结果。响应为数组;number 是仓库内 PR 编号,head/base 是来源和目标分支。 以下为结构示意,非本站实测结果。
[
{
"number": 7,
"state": "open",
"title": "示例变更",
"draft": false,
"html_url": "https://github.com/example-owner/example-repo/pull/7",
"head": {
"ref": "example-feature"
},
"base": {
"ref": "main"
}
}
]常见错误与排查
HTTP 422筛选参数无效或请求被判定为滥用。- 核对 state、sort、direction;放慢轮询并检查限流响应头。
调用注意
- 返回第一页不等于取得全部结果;跟随 Link 的 rel=next,直到没有下一页。
- PR 也是一种 Issue,但文件改动、评审与合并状态属于 Pull requests 接口,不能只读 Issue 标题判断能否合并。
注意事项
- 个人令牌通常共用每小时 5,000 次的主额度;次级限流仍可提前触发。公开读取不携带令牌时通常为每 IP 每小时 60 次。
- 本例不运行 Actions、不上传付费存储;账号套餐、仓库功能及 API 配额仍按 GitHub 规则执行。
核验来源
本站按官方资料整理本场景的必要调用步骤与代码,覆盖范围以本页列出的接口为准。官方资料用于追溯规范及查看变更。
- 01创建 Fine-grained personal access token核验日期 2026-10-15
- 02REST API 主要与次级限流核验日期 2026-10-15
- 03List pull requests核验日期 2026-10-15