列出 watch 了仓库的用户¶

GET /api/v5/repos/{owner}/{repo}/subscribers

用户调用此接口，进行列出 watch 了仓库的用户操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20
`watched_after`	query	string	否	在此之后 watch 的时间
`watched_before`	query	string	否	在此之前 watch 的时间

响应参数¶

数组元素

字段	类型	必返	可为空	说明
`id`	integer	是	否	用户 ID
`login`	string	是	否	用户登录名
`name`	string	是	否	用户名
`avatar_url`	string	是	否	用户头像地址
`watch_at`	string	是	否	watch 时间，格式如 `2024-11-13T16:15:53.287+08:00`

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数错误"
}

401 未认证

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

注意： 错误响应字段名以后端实际返回为准，上例仅为常见形态。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）。

此接口允许匿名访问，示例中未携带访问令牌；如需携带，可在 URL 后追加 ?access_token=<token>。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/subscribers?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>/subscribers?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>/subscribers",
    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/uploads/avatar/xiaogang.jpg",
    "watch_at": "2024-11-13T16:15:53.287+08:00"
  }
]

错误码¶

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

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