获取仓库动态¶

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

该接口用于获取指定仓库的动态（事件）列表，支持按事件类型、触发人及日期范围进行筛选，并支持分页返回事件详情信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(企业、组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`filter`	query	string	否	筛选条件，传入 `all`（所有的）、`push`（push事件）、`merged`（merged事件）、`issue`（issue事件）、`comments`（评论事件）、`team`（团队事件）、`project`（项目事件）
`author`	query	string	否	事件触发人，传入用户名
`before`	query	string	否	起始日期，格式为 `YYYY-MM-DD`，用来限定返回的事件的起始时间
`after`	query	string	否	结束日期，格式为 `YYYY-MM-DD`，用来限定返回的事件的结束时间
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20

响应参数¶

字段	类型	必返	可为空	说明
`events`	object[]	是	是	仓库动态事件列表
`has_next_page`	integer	是	—	是否存在下一页，非 0 表示还有更多

events 对象

字段	类型	必返	可为空	说明
`events.action`	integer	是	—	事件类型编码
`events.action_name`	string	是	—	事件类型名称，如 `opened`、`push` 等
`events.author`	object	是	—	事件触发者信息
`events.author_id`	integer	是	—	事件触发者 ID
`events.author_username`	string	是	—	事件触发者用户名
`events.created_at`	string	是	—	事件创建时间
`events.project_id`	integer	是	—	仓库 ID
`events.title`	string	是	—	事件标题
`events.filter_sensitive`	integer	是	—	是否过滤敏感信息（0/1，示例中也可能返回布尔值）

`events.author` 对象¶

字段	类型	必返	可为空	说明
`events.author.id`	integer	是	—	用户 ID
`events.author.iam_id`	string	是	—	IAM 用户标识
`events.author.username`	string	是	—	用户名
`events.author.state`	string	是	—	用户状态，如 `active`
`events.author.email`	string	是	是	邮箱，可能为空字符串
`events.author.name`	string	是	—	用户姓名
`events.author.name_cn`	string	是	是	用户中文姓名，可能为空字符串
`events.author.web_url`	string	是	—	用户主页地址

失败响应¶

只有 200/成功响应是不够的：调用方需要知道失败长什么样才能写错误处理。

以下为网关/框架层面的通用失败响应，错误字段名以后端实际返回为准：

400 参数错误

{
  "message": "参数 owner 不能为空"
}

401 未认证

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

404 仓库不存在

{
  "message": "仓库不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	仓库不存在（Not found）

请求示例¶

参数说明¶

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

本接口允许匿名访问，示例无需携带访问令牌；如有需要，也可以通过 access_token 查询参数携带 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/events?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>/events", {
  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>/events",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "events": [
    {
      "action": 22,
      "action_name": "opened",
      "author": {
        "id": 607,
        "iam_id": "f09ca8d721eb49e4add47b67c0dbef81",
        "username": "xiaogang",
        "state": "active",
        "email": "",
        "name": "xiaogang",
        "name_cn": "",
        "web_url": "https://api.atomgit.com/xiaogang"
      },
      "author_id": 607,
      "author_username": "xiaogang",
      "created_at": "2024-11-19T07:01:02.714Z",
      "project_id": 249609,
      "title": "{\"userid\":[496],\"username\":[\"xiaogang\"]}",
      "filter_sensitive": 0
    }
  ],
  "has_next_page": 0
}

错误码¶

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

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