获取组织讨论评论列表¶
GET /api/v5/orgs/{org}/discuss/{number}/comment
该接口用于获取指定组织下某个讨论的评论列表,支持分页与按创建时间、热度值排序,返回内容包含评论内容、点赞数、回复数及作者信息等。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
org |
path | string | 是 | 组织的path |
number |
path | string | 是 | 讨论的编号 |
access_token |
query | string | 否 | 用户授权码 |
page |
query | string | 否 | 当前的页码 |
per_page |
query | string | 否 | 每页的数量,最大为 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 | 是 | 否 | 作者头像地址 |
author.id |
string | 是 | 否 | 作者 ID |
author.object_id |
string | 是 | 否 | 作者对象 ID |
author.login |
string | 是 | 否 | 作者登录名 |
author.name |
string | 是 | 否 | 作者昵称 |
失败响应¶
该接口无明确的业务失败响应,失败时返回对应的 HTTP 错误状态码(见「HTTP 响应状态码」)。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
304 |
未修改(Not modified) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
请求示例¶
参数说明¶
<org>替换为组织的 path;<number>替换为讨论的编号;<token>替换为你的 AtomGit 用户访问令牌(可选)。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>/comment?page=1&per_page=20&order=time_desc' \
-H 'Accept: application/json'
JavaScript¶
// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/orgs/<org>/discuss/<number>/comment?page=1&per_page=20&order=time_desc", {
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/orgs/<org>/discuss/<number>/comment",
params={"page": 1, "per_page": 20, "order": "time_desc"},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
[
{
"id": "string",
"created_at": "string",
"author": {
"avatar_url": "string",
"id": "string",
"object_id": "string",
"login": "string",
"name": "string"
},
"content": "string",
"md_content": "string",
"is_hide": 0,
"reply_total": 0,
"like_total": 0,
"is_like": true,
"is_deleted": 0,
"is_remark": 0
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
400 |
参数错误或请求无法解析 |
404 |
请求路径不存在 |
405 |
请求方法不支持 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc