获取仓库的Commit评论¶
GET /api/v5/repos/{owner}/{repo}/comments
该接口用于获取指定仓库的 Commit 评论列表,支持通过页码与每页数量参数进行分页查询,并可选择按评论的升序或降序排列,便于用户浏览和检索仓库中针对各提交的评论内容。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(企业、组织或个人的地址path) |
repo |
path | string | 是 | 仓库路径(path) |
page |
query | integer | 否 | 当前的页码 |
per_page |
query | integer | 否 | 每页的数量,最大为 100,默认 20 |
order |
query | string | 否 | 排序顺序:asc(默认)/ desc |
响应参数¶
响应为 Commit 评论对象数组,每个对象结构如下:
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
body |
string | 是 | 是 | 评论内容 |
body_html |
string | 否 | 是 | 评论内容的 HTML 渲染(当前实现未填充) |
created_at |
string | 是 | 是 | 评论创建时间 |
id |
integer | 是 | 否 | 评论 ID |
in_reply_to_id |
integer | 否 | 是 | 回复的父评论 ID(当前实现未填充) |
in_reply_to_user |
object | 否 | 是 | 被回复评论的作者信息(当前实现未填充) |
source |
string | 否 | 是 | 评论来源(当前实现未填充) |
target |
object | 是 | 否 | 评论关联的目标对象 |
updated_at |
string | 是 | 是 | 评论更新时间 |
user |
object | 是 | 否 | 评论作者信息 |
target 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
target.issue |
object | 否 | 是 | 关联的 Issue(当前实现未填充) |
target.pull_request |
object | 否 | 是 | 关联的 Pull Request(当前实现未填充) |
user 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user.id |
integer | 是 | 否 | 用户 ID |
user.login |
string | 是 | 否 | 登录名 |
user.name |
string | 是 | 是 | 用户名 |
user.type |
string | 是 | 否 | 用户类型,如 User |
user.avatar_url |
string | 否 | 是 | 头像 URL |
user.url |
string | 否 | 是 | 用户 URL |
user.html_url |
string | 否 | 是 | 用户主页 URL |
user.remark |
string | 否 | 是 | 企业备注名 |
user.followers_url |
string | 否 | 是 | 粉丝列表 URL |
user.following_url |
string | 否 | 是 | 关注列表 URL |
user.gists_url |
string | 否 | 是 | 代码片段 URL |
user.starred_url |
string | 否 | 是 | 收藏列表 URL |
user.subscriptions_url |
string | 否 | 是 | 订阅列表 URL |
user.organizations_url |
string | 否 | 是 | 组织列表 URL |
user.repos_url |
string | 否 | 是 | 仓库列表 URL |
user.events_url |
string | 否 | 是 | 事件列表 URL |
user.received_events_url |
string | 否 | 是 | 接收事件列表 URL |
user.permission |
string | 否 | 是 | 用户权限 |
user.object_id |
string | 否 | 是 | 对象 ID |
user.email |
string | 否 | 是 | 用户邮箱 |
失败响应¶
400 参数错误
401 未认证
404 资源不存在
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
304 |
未修改(Not modified) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
资源不存在(Not found) |
请求示例¶
参数说明¶
示例可直接复制调用。占位符含义:
<owner>替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo>替换为仓库路径(path)。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/comments?page=1&per_page=20&order=asc' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
"https://api.atomgit.com/api/v5/repos/<owner>/<repo>/comments?page=1&per_page=20&order=asc",
{
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>/comments",
params={"page": 1, "per_page": 20, "order": "asc"},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
[
{
"body": "这个提交修复了登录问题,感谢!",
"created_at": "2024-11-06T09:43:23+08:00",
"id": 1492393,
"target": {
"issue": null,
"pull_request": null
},
"updated_at": "2024-11-06T15:18:04+08:00",
"user": {
"id": 496,
"login": "xiaogang",
"name": "xiaogang",
"type": "User"
}
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
400 |
参数错误或请求无法解析 |
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc