获取Pull Request的表态列表¶
GET /api/v5/repos/{owner}/{repo}/pulls/{number}/user_reactions
该接口用于获取指定仓库中指定 Pull Request 的表态列表,返回每条表态对应的 emoji 表情及表态用户信息,支持按表情类型筛选与分页浏览。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(企业、组织或个人的地址 path) |
repo |
path | string | 是 | 仓库路径(path) |
number |
path | string | 是 | Pull Request 编号(区分大小写,无需添加 # 号) |
page |
query | string | 否 | 当前页码 |
per_page |
query | string | 否 | 每页数量 |
emoji_name |
query | string | 否 | emoji 表情,可选:like、dislike、smile、confused、love、rocket、eyes、party |
响应参数¶
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
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 |
失败响应¶
该接口未定义业务失败响应。失败时错误字段名以后端实际返回为准。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
401 |
需要认证(Requires authentication) |
403 |
禁止访问(Forbidden) |
404 |
资源不存在(Not found) |
请求示例¶
参数说明¶
示例为匿名访问方式(本接口允许匿名访问),也可附加 access_token 查询参数进行已认证访问。
<owner>替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo>替换为仓库路径(path);<number>替换为 Pull Request 编号(区分大小写,无需添加#号);若需认证访问,追加?access_token=<token>(<token>为你的 AtomGit 用户访问令牌)。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/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>/pulls/<number>/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>/pulls/<number>/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
响应体为 JSON 数组,每个元素为一个表态对象。
[
{
"id": "1",
"emoji": "👍",
"emoji_name": "like",
"user": {
"login": "octocat",
"name": "Octocat",
"avatar_url": "https://api.atomgit.com/avatar.png",
"object_id": "12345"
}
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
403 |
禁止访问(没有权限) |
404 |
资源不存在 |
429 |
请求过于频繁,触发限流 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc