跳转至

获取issue评论的表态列表

GET /api/v5/repos/{owner}/{repo}/issues/comment/{comment_id}/user_reactions

该接口用于获取指定 issue 评论的表态列表,返回用户对该评论的 emoji 表态记录,包含表态的 emoji 表情、枚举值及表态用户信息,并支持按 emoji 表情筛选和分页查询。

访问令牌支持说明

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

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(组织或个人的地址 path)
repo path string 是 仓库路径(path)
comment_id path string 是 评论的 ID
page query string 否 当前页码
per_page query string 否 每页数量
emoji_name query string 否 emoji 表情,可选:like / dislike / smile / confused / love / rocket / eyes / party

响应参数

字段 类型 必返 可为空 说明
(数组元素) object 是 — 表态记录对象(响应体为表态记录数组)

表态记录对象

字段 类型 必返 可为空 说明
id string 是 — 表态记录 ID
emoji string 是 — emoji 表情
emoji_name string 是 — emoji 表情枚举值
user object 是 — 表态用户信息

user 对象

字段 类型 必返 可为空 说明
user.login string 是 — 登录名
user.name string 是 — 用户名称
user.avatar_url string 是 — 用户头像地址
user.object_id string 是 — 用户对象 ID

失败响应

该接口允许匿名访问,正常情况下无需认证即可成功;以下为常见的失败响应示例。错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 emoji_name 取值不合法",
  "field": "emoji_name"
}

401 未认证

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

HTTP 响应状态码

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

请求示例

参数说明

该接口允许匿名访问,因此示例中可不携带访问令牌;如需携带,在 URL 查询参数中追加 access_token=<token> 即可。

<owner> 替换为仓库所属空间地址(组织或个人的地址 path);<repo> 替换为仓库路径(path);<comment_id> 替换为评论 ID。page、per_page、emoji_name 均为可选查询参数。

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/comment/<comment_id>/user_reactions?page=1&per_page=20&emoji_name=like' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/comment/<comment_id>/user_reactions?page=1&per_page=20&emoji_name=like", {
  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/comment/<comment_id>/user_reactions",
    params={"page": 1, "per_page": 20, "emoji_name": "like"},
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

[
  {
    "id": "12345",
    "emoji": "👍",
    "emoji_name": "like",
    "user": {
      "login": "octocat",
      "name": "Octo Cat",
      "avatar_url": "https://api.atomgit.com/avatar/octocat.png",
      "object_id": "1001"
    }
  }
]

错误码

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

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