获取单个commit评论¶

GET /api/v5/repos/{owner}/{repo}/commits/{ref}/comments

该接口用于获取指定仓库中某个 commit 的评论列表，支持分页查询，返回每条评论的内容、创建及更新时间，以及发表评论的用户信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`ref`	path	string	是	commit 的 sha
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20

响应参数¶

该接口返回一个数组，数组中的每个元素为一个 commit 评论对象。

字段	类型	必返	可为空	说明
`body`	string	是	是	评论内容
`created_at`	string	是	是	评论创建时间
`id`	integer	是	否	评论 ID
`updated_at`	string	是	是	评论更新时间
`user`	object	是	否	发表评论的用户信息

user 对象

字段	类型	必返	可为空	说明
`user.id`	integer	是	否	用户 ID
`user.login`	string	是	是	用户登录名
`user.name`	string	是	是	用户名称
`user.type`	string	是	是	用户类型

失败响应¶

该接口的参考文档未提供失败响应示例，可依据 HTTP 状态码判断错误类型，具体错误字段以实际返回为准。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

该接口允许匿名访问，也可通过 ?access_token=<token> 携带 AtomGit 用户访问令牌。

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）； <repo> 替换为仓库路径（path）； <ref> 替换为 commit 的 sha。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/commits/<ref>/comments?page=1&per_page=20' \
  -H 'Accept: application/json'

JavaScript¶

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "body": "11111",
    "created_at": "2024-11-19T11:22:50+08:00",
    "id": 13837749,
    "updated_at": "2024-11-19T11:22:50+08:00",
    "user": {
      "id": 173794,
      "login": "xiaogang",
      "name": "肖刚",
      "type": "User"
    }
  }
]

错误码¶

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

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