获取仓库的某条Commit评论¶
GET /api/v5/repos/{owner}/{repo}/comments/{id}
该接口用于获取指定仓库中某条 Commit 评论的详情,返回该评论的内容、创建时间、更新时间、评论目标对象以及发表评论的用户信息。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(组织或个人的地址 path) |
repo |
path | string | 是 | 仓库路径(path) |
id |
path | string | 是 | 评论 id |
access_token |
query | string | 否 | 用户授权码 |
响应参数¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
body |
string | 是 | — | 评论内容 |
created_at |
string | 是 | — | 评论创建时间 |
id |
integer | 是 | — | 评论 id |
target |
object | 是 | — | 评论目标对象(具体结构以实际返回为准) |
updated_at |
string | 是 | — | 评论更新时间 |
user |
object | 是 | — | 发表评论的用户信息 |
user 对象
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
user.id |
integer | 是 | — | 用户 id |
user.login |
string | 是 | — | 用户登录名 |
user.name |
string | 是 | — | 用户名 |
user.type |
string | 是 | — | 用户类型(如 User) |
失败响应¶
参考文档未定义该接口的失败响应格式。若仓库、评论不存在或访问被拒绝,后端将返回相应的错误状态码(如 404、401),具体错误字段以后端实际返回为准。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
401 |
需要认证(Requires authentication) |
404 |
资源不存在(Not found) |
请求示例¶
参数说明¶
<owner>替换为仓库所属空间地址(组织或个人的地址 path);<repo>替换为仓库路径(path);<id>替换为评论 id。本接口允许匿名访问,示例未携带访问令牌;如需以用户身份调用,可在 URL 上追加查询参数
access_token=<token>。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/comments/<id>' -H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/comments/<id>", {
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/<id>",
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc