获取文件Blob¶

GET /api/v5/repos/{owner}/{repo}/git/blobs/{sha}

该接口用于根据指定的仓库及文件 Blob SHA 获取对应的文件 Blob 内容，返回文件的内容大小、资源访问地址、Base64 编码后的内容及其编码方式等信息。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`sha`	path	string	是	文件的 Blob SHA，可通过「获取仓库具体路径下的内容」接口获取

响应参数¶

字段	类型	必返	可为空	说明
`sha`	string	是	否	文件的 Blob SHA
`size`	integer	是	否	文件内容大小（字节数）
`url`	string	是	否	Blob 资源的访问地址
`content`	string	是	否	文件内容（Base64 编码）
`encoding`	string	是	否	文件内容编码方式，示例值为 `base64`

失败响应¶

该接口可能返回的失败示例如下；错误字段名以后端实际返回为准，无法确认时请以实际响应为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数不合法"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

404 资源不存在

{
  "error": "not_found",
  "message": "文件 Blob 不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<sha> 替换为文件的 Blob SHA。

本接口允许匿名访问，示例可不携带访问令牌；如有需要，也可携带 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/blobs/<sha>' -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/blobs/<sha>", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/git/blobs/<sha>",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "sha": "e5699fe1b360d6c799ee58b24fb5a670b1e14851",
  "size": 19,
  "url": "https://api.atomgit.com/api/v5/repos/daming_1/zhu_di/git/blobs/e5699fe1b360d6c799ee58b24fb5a670b1e14851",
  "content": "JXU2RDRCJXU4QkQ1d2ViaG9vaw==",
  "encoding": "base64"
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`400`	参数错误或请求无法解析
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc