跳转至

获取项目讨论评论列表

GET /api/v5/repos/{owner}/{repo}/discuss/{number}/comment

该接口用于获取指定仓库中项目讨论下的评论列表,支持按页码与每页数量分页查询,也可按评论的创建时间或热度值进行排序,并返回评论内容、作者信息、点赞数及回复数等相关数据。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(企业、组织或个人的地址 path)
repo path string 是 仓库路径(path)
number path string 是 讨论编号
page query integer 否 当前的页码
per_page query integer 否 每页的数量,最大为 100,默认 20
order query string 否 排序方式:按创建时间升序 time_asc;按创建时间降序 time_desc;按热度值降序 hot_desc

响应参数

字段 类型 必返 可为空 说明
id string 是 否 评论 ID
created_at string 是 否 评论创建时间
author object 是 否 评论作者信息
content string 是 — 评论内容
md_content string 是 — 评论的 Markdown 内容
is_hide integer 是 — 是否隐藏
reply_total integer 是 — 回复总数
like_total integer 是 — 点赞总数
is_like boolean 是 — 当前用户是否已点赞
is_deleted integer 是 — 是否已删除
is_remark integer 是 — 是否为备注

author 对象

字段 类型 必返 可为空 说明
author.avatar_url string 是 否 用户头像 URL
author.id string 是 否 用户 ID
author.object_id string 是 否 用户对象 ID
author.login string 是 否 登录名
author.name string 是 否 昵称

失败响应

400 参数错误

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

401 未认证

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

404 资源不存在

{
  "error": "not_found",
  "message": "仓库、讨论或评论不存在"
}

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

HTTP 响应状态码

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

请求示例

参数说明

<owner> 替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo> 替换为仓库路径(path);<number> 替换为讨论编号。本接口允许匿名访问,也可携带 <token>(用户访问令牌)作为 access_token 查询参数(可选)。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/discuss/<number>/comment?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>/discuss/<number>/comment?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>/discuss/<number>/comment",
    params={"page": 1, "per_page": 20},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": "123456",
    "created_at": "2026-01-01T10:00:00+08:00",
    "author": {
      "avatar_url": "https://api.atomgit.com/assets/avatars/octocat.png",
      "id": "1001",
      "object_id": "1001",
      "login": "octocat",
      "name": "Octo Cat"
    },
    "content": "这是一个讨论评论示例",
    "md_content": "这是一个讨论评论示例",
    "is_hide": 0,
    "reply_total": 2,
    "like_total": 5,
    "is_like": true,
    "is_deleted": 0,
    "is_remark": 0
  }
]

错误码

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

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