读取仓库中的文件

读取指定路径的文件内容及版本 SHA，可用于配置同步和代码归档。

官方资料核对 2026-10-15示例代码，未进行真实接口实测

接入准备

私有仓库需令牌覆盖目标仓库，Contents: 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 设置 Contents: Read-only。组织要求审批时，等待管理员批准后再读取私有资源。
04
生成后复制令牌到 GITHUB_TOKEN；从仓库 URL 提取 GITHUB_OWNER 与 GITHUB_REPO。不要把令牌放进网页源码。

调用 01

读取 README.md

示例请求默认分支的 README.md；换成自己的文件路径，目录与文件返回结构不同。

GEThttps://api.github.com/repos/${GITHUB_OWNER}/${GITHUB_REPO}/contents/README.md

请求头

Accept: application/vnd.github+json
Authorization: Bearer ${GITHUB_TOKEN}
X-GitHub-Api-Version: 2026-03-10

参数说明

参数表可左右滑动，查看完整说明。

字段 / 位置	类型 / 必填	说明
`owner / repo`Path	string必填	由仓库地址提取，示例通过环境变量传入。
`path`Path	string必填	仓库内相对路径；示例 README.md，路径含空格或中文须 URL 编码。
`ref`Query	string可选	分支、标签或提交 SHA；省略时使用默认分支。

调用代码

替换示例 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}/contents/README.md" \
  --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}/contents/README.md")
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}/contents/README.md");
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、文本和数字均为虚构，非接口实测结果。文件的 content 按 encoding 解码；不要把 download_url 当作永久链接。以下为结构示意，非本站实测结果。

{
  "type": "file",
  "name": "README.md",
  "path": "README.md",
  "sha": "1111111111111111111111111111111111111111",
  "size": 7,
  "encoding": "base64",
  "content": "SGVsbG8hCg==",
  "html_url": "https://github.com/example-owner/example-repo/blob/main/README.md"
}

常见错误与排查

HTTP 403访问被拒绝，也可能触发限流。: 先核对令牌权限和仓库范围；检查 x-ratelimit-remaining、x-ratelimit-reset 或 retry-after，再决定何时重试。
HTTP 404未找到资源或调用身份看不到目标资源。: 检查仓库、路径拼写以及组织审批状态；不要据此断言私有仓库不存在。

调用注意

示例面向小于 1 MB 的普通文件；1–100 MB 文件需按官方指定媒体类型处理，超过 100 MB 不支持此接口。
读取目录最多返回 1,000 项；递归或更大目录应使用 Git Trees。Base64 解码在应用端完成。

Get repository content

注意事项

个人令牌通常共用每小时 5,000 次的主额度；次级限流仍可提前触发。公开读取不携带令牌时通常为每 IP 每小时 60 次。
本例不运行 Actions、不上传付费存储；账号套餐、仓库功能及 API 配额仍按 GitHub 规则执行。

核验来源

本站按官方资料整理本场景的必要调用步骤与代码，覆盖范围以本页列出的接口为准。官方资料用于追溯规范及查看变更。

01
创建 Fine-grained personal access token核验日期 2026-10-15
02
REST API 主要与次级限流核验日期 2026-10-15
03
Get repository content核验日期 2026-10-15

GitHub的其他调用手册

把外部反馈创建为 Issue 查询待处理拉取请求

← 返回GitHub的全部功能