获取文件列表¶

GET /api/v5/repos/{owner}/{repo}/file_list

该接口用于获取指定仓库下的文件列表，可通过分支、标签或提交信息定位文件版本，并支持按文件名查找，响应返回仓库中所有文件的路径列表。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`ref_name`	query	string	否	ref（分支、tag、commit）
`file_name`	query	string	否	要查找的文件名称

响应参数¶

响应体为字符串数组，数组元素为文件路径，表示仓库中的文件列表。

字段	类型	必返	可为空	说明
（数组元素）	string	是	否	文件路径，如 `abc/test.rs`

失败响应¶

除成功响应外，该接口在访问私有仓库或资源不存在时可能返回以下失败响应。

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "仓库不存在"
}

错误字段名以后端实际返回为准。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

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

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）； <repo> 替换为仓库路径（path）； <ref> 替换为分支、tag 或 commit（可选）； <file_name> 替换为要查找的文件名称（可选）。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/file_list?ref_name=<ref>&file_name=<file_name>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/file_list?ref_name=<ref>&file_name=<file_name>",
  {
    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>/file_list",
    params={"ref_name": "<ref>", "file_name": "<file_name>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  "abc/test.rs",
  "bcd/test.rs"
]

错误码¶

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

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