获取仓库某个Issue所有的评论¶

GET /api/v5/repos/{owner}/{repo}/issues/{number}/comments

该接口用于获取指定仓库中某个 Issue 的全部评论，支持分页、排序及按起始更新时间筛选，返回每条评论的内容、发表用户和关联 Issue 等信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`number`	path	string	是	Issue 编号(区分大小写，无需添加 # 号)
`access_token`	query	string	否	用户授权码
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20
`order`	query	string	否	排序顺序：`asc`（默认）/ `desc`
`since`	query	string	否	起始的更新时间，要求时间格式为 `2024-11-10T08:10:30.000+08:00`（注意 + 号要 URL 编码为 `%2B`）

响应参数¶

响应为一个评论对象数组，每个评论包含以下字段：

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

user 对象

字段	类型	必返	可为空	说明
`user.avatar_url`	string	是	否	用户头像地址
`user.events_url`	string	否	是	事件 URL
`user.followers_url`	string	否	是	关注者列表 URL
`user.following_url`	string	否	是	正在关注的用户列表 URL
`user.gists_url`	string	否	是	Gist 列表 URL
`user.html_url`	string	是	否	用户主页地址
`user.id`	string	是	否	用户 ID
`user.login`	string	是	否	登录名
`user.member_role`	string	否	是	成员角色
`user.name`	string	是	否	用户名
`user.organizations_url`	string	否	是	组织列表 URL
`user.received_events_url`	string	否	是	收到的事件 URL
`user.remark`	string	否	是	备注
`user.repos_url`	string	否	是	仓库列表 URL
`user.starred_url`	string	否	是	星标仓库列表 URL
`user.subscriptions_url`	string	否	是	订阅列表 URL
`user.type`	string	否	是	用户类型
`user.url`	string	否	是	用户 URL

target 对象

字段	类型	必返	可为空	说明
`target.issue`	object	是	否	评论关联的 Issue

`target.issue` 对象¶

字段	类型	必返	可为空	说明
`target.issue.id`	integer	是	否	Issue ID
`target.issue.title`	string	是	否	Issue 标题
`target.issue.nubmer`	integer	是	否	Issue 编号

失败响应¶

该接口无业务失败响应。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在（Not found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<number> 替换为 Issue 编号（区分大小写，无需添加 # 号）。

cURL¶

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

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 271624,
    "body": "评论内容。",
    "user": {
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "html_url": "https://api.atomgit.com/dengmengmian",
      "id": "661ce4eab470b1430d456154",
      "login": "dengmengmian",
      "name": "麻凡_"
    },
    "target": {
      "issue": {
        "id": 152134,
        "title": "",
        "nubmer": 1
      }
    },
    "created_at": "2024-04-19T17:50:18.199+08:00",
    "updated_at": "2024-04-19T17:50:18.199+08:00"
  }
]

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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