列出 star 了仓库的用户¶
GET /api/v5/repos/{owner}/{repo}/stargazers
用户调用此接口,列出所有 star 了指定仓库的用户。
访问令牌支持说明¶
- AtomGit 用户访问令牌(AtomGit user access tokens)
是否允许匿名访问¶
此接口允许匿名访问
请求参数¶
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
owner |
path | string | 是 | 仓库所属空间地址(企业、组织或个人的地址 path) |
repo |
path | string | 是 | 仓库路径(path) |
page |
query | integer | 否 | 当前的页码 |
per_page |
query | integer | 否 | 每页的数量,最大为 100,默认 20 |
starred_after |
query | string | 否 | 在此之后 star 的 |
starred_before |
query | string | 否 | 在此之前 star 的 |
响应参数¶
响应体为 JSON 数组,数组的每个元素是一个 star 了该仓库的用户对象,字段如下:
stargazer 对象(数组元素)
| 字段 | 类型 | 必返 | 可为空 | 说明 |
|---|---|---|---|---|
id |
integer | 是 | 否 | 用户 ID |
login |
string | 是 | 否 | 用户登录名 |
name |
string | 是 | 否 | 用户名称 |
avatar_url |
string | 是 | 否 | 用户头像地址 |
starred_at |
string | 是 | 否 | star 该仓库的时间 |
失败响应¶
参考文档仅定义了成功响应,未提供业务失败响应示例;失败时错误字段名以后端实际返回为准。
HTTP 响应状态码¶
| 状态码 | 说明 |
|---|---|
200 |
成功(OK) |
401 |
需要认证(Requires authentication) |
404 |
资源不存在(Not found) |
500 |
系统内部错误(Internal server error) |
请求示例¶
参数说明¶
本接口允许匿名访问,示例中不携带访问令牌;如需以特定用户身份访问私有资源,可在请求中追加 access_token 查询参数(用户授权码)。
<owner>替换为仓库所属空间地址(企业、组织或个人的地址 path);<repo>替换为仓库路径(path)。
cURL¶
curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/stargazers?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>/stargazers?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>/stargazers",
params={"page": 1, "per_page": 20},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
响应示例¶
状态码: 200
[
{
"id": 496,
"login": "xiaogang",
"name": "xiaogang",
"avatar_url": "https://api.atomgit.com/avatar.png",
"starred_at": "2024-11-13T16:15:53.287+08:00"
}
]
错误码¶
| 错误码 | 说明 |
|---|---|
401 |
未认证或凭证无效(缺少/无效的访问凭证) |
404 |
请求路径不存在 |
500 |
系统内部错误 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc