获取仓库所有里程碑¶

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

该接口用于获取指定仓库的全部里程碑，支持按状态筛选（开放、关闭或全部），并可依据截止日期排序及分页查看，返回里程碑的标题、状态、截止日期及关联的 Issue 数量等信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址path）
`repo`	path	string	是	仓库路径(path)
`state`	query	string	否	里程碑状态，枚举：`open` / `closed` / `all`；默认 `open`
`sort`	query	string	否	排序方式，枚举：`due_on`
`direction`	query	string	否	排序方向，枚举：`asc` / `desc`；默认 `asc`
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 100，默认 20

响应参数¶

milestone 对象（响应为数组，元素为里程碑对象）

字段	类型	必返	可为空	说明
`closed_issues`	integer	是	—	已关闭的 Issue 数量
`created_at`	string	是	—	创建时间
`description`	string	是	—	里程碑描述
`due_on`	string	是	—	截止日期
`number`	integer	是	—	里程碑编号
`open_issues`	integer	是	—	未关闭的 Issue 数量
`repository_id`	integer	是	—	所属仓库 ID
`state`	string	是	—	里程碑状态
`title`	string	是	—	里程碑标题
`updated_at`	string	是	—	更新时间
`url`	string	是	—	里程碑的 URL

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "参数不合法",
  "field": "per_page"
}

401 未认证

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

Note: 错误字段名与提示信息以后端实际返回为准。

HTTP 响应状态码¶

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

请求示例¶

参数说明¶

示例均以匿名方式调用；如需携带令牌，可在请求中附带 access_token 查询参数。

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

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/milestones?state=open&direction=asc&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>/milestones?state=open&direction=asc&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>/milestones",
    params={"state": "open", "direction": "asc", "page": 1, "per_page": 20},
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "closed_issues": 0,
    "created_at": "2024-10-08T10:58:16+08:00",
    "description": "你好中国",
    "due_on": "2024-11-08",
    "number": 4914,
    "open_issues": 0,
    "repository_id": 4066481,
    "state": "active",
    "title": "你好中国",
    "updated_at": "2024-10-08T10:58:16+08:00",
    "url": "https://api.atomgit.com/dengmengmian/oneapi/milestones/1"
  }
]

错误码¶

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

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