获取仓库所有 issues¶

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

该接口用于获取指定仓库内的所有 issue 列表，支持按状态、标签、里程碑、指派人、创建者及时间范围等条件筛选，并可通过关键字搜索 issue 标题或内容，同时支持分页与排序，返回包含 issue 详情、标签、里程碑等信息的完整数据。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`state`	query	string	否	Issue 的状态：`open`（开启的）、`closed`（关闭的）、`all`（所有）。默认 `all`
`labels`	query	string	否	用逗号分开的标签，如 `bug,performance`
`sort`	query	string	否	排序依据：创建时间（`created`）、更新时间（`updated`）。默认 `created`
`direction`	query	string	否	排序方式：升序（`asc`）、降序（`desc`）。默认 `desc`
`since`	query	string	否	起始的更新时间，要求时间格式为 `2024-11-10T08:10:30.000+08:00`（注意 `+` 号要 URL 编码为 `%2B`）
`page`	query	integer	否	当前的页码
`per_page`	query	integer	否	每页的数量，最大为 `100`，默认 `20`
`created_at`	query	string	否	任务创建时间，例如：`2024-11-20T13:00:21+08:00`
`milestone`	query	string	否	根据里程碑标题筛选；`none` 为没有里程碑的 issue
`assignee`	query	string	否	Issue 指派人的 ID
`creator`	query	string	否	创建 issue 的用户的 username
`created_after`	query	string	否	返回在指定时间之后创建的问题，例如：`2024-11-20T13:00:21+08:00`
`created_before`	query	string	否	返回在指定时间之前创建的问题，例如：`2024-11-20T13:00:21+08:00`
`updated_after`	query	string	否	返回在指定时间之后更新的问题，例如：`2024-11-20T13:00:21+08:00`
`updated_before`	query	string	否	返回在指定时间之前更新的问题，例如：`2024-11-20T13:00:21+08:00`
`search`	query	string	否	通过关键字搜索 issue 标题或内容

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	否	issue 的 ID
`html_url`	string	是	否	issue 的 HTML 链接
`number`	string	是	否	issue 的编号
`state`	string	是	否	issue 的状态
`title`	string	是	否	issue 的标题
`body`	string	是	否	issue 的正文内容
`user`	object	是	否	创建 issue 的用户信息
`repository`	object	是	否	issue 所属仓库信息
`created_at`	string	是	否	创建时间
`updated_at`	string	是	否	更新时间
`finished_at`	string	是	是	完成时间，可能为 `null`
`labels`	object[]	是	否	issue 的标签列表
`issue_state`	string	是	否	issue 状态
`comments`	integer	是	否	评论数量
`priority`	integer	是	是	优先级，可能为 `null`
`issue_type`	string	是	是	issue 类型，可能为 `null`
`issue_state_detail`	object	是	是	issue 状态详情，可能为 `null`
`issue_type_detail`	object	是	否	issue 类型详情
`issue_priority_detail`	object	否	是	issue 优先级详情，可能为 `null`
`milestone`	object	是	否	关联的里程碑信息
`assignee`	object	是	否	指派人信息
`visibility_reason`	string	否	是	可见性：`public` 公开可见，`confidential` 私密、项目成员可见，`other` 其他原因导致的仅项目成员可见

user 对象

字段	类型	必返	可为空	说明
`user.avatar_url`	string	是	否	用户头像链接
`user.html_url`	string	是	否	用户主页链接
`user.id`	string	是	否	用户 ID
`user.login`	string	是	否	登录名
`user.name`	string	是	否	用户名

repository 对象

字段	类型	必返	可为空	说明
`repository.id`	integer	是	否	仓库 ID
`repository.full_name`	string	是	否	仓库完整名称
`repository.path`	string	是	否	仓库路径
`repository.name`	string	是	否	仓库名称
`repository.description`	string	是	否	仓库描述
`repository.created_at`	string	是	否	仓库创建时间
`repository.updated_at`	string	是	否	仓库更新时间
`repository.assigner`	object	是	是	指派人对象，内部结构以实际返回为准
`repository.paas`	string	是	是	paas 标识，可能为 `null`

labels 数组元素

字段	类型	必返	可为空	说明
`labels[].id`	integer	否	是	标签 ID
`labels[].name`	string	否	是	标签名称
`labels[].color`	string	否	是	标签颜色
`labels[].created_at`	string	否	是	标签创建时间
`labels[].updated_at`	string	否	是	标签添加时间

issue_state_detail 对象

字段	类型	必返	可为空	说明
`issue_state_detail.title`	string	是	否	状态标题
`issue_state_detail.serial`	integer	是	否	状态序号
`issue_state_detail.id`	integer	否	是	状态 ID

issue_type_detail 对象

字段	类型	必返	可为空	说明
`issue_type_detail.title`	string	是	否	类型标题
`issue_type_detail.id`	integer	是	否	类型 ID
`issue_type_detail.is_system`	boolean	是	否	是否为系统类型

issue_priority_detail 对象

字段	类型	必返	可为空	说明
`issue_priority_detail.id`	string	是	否	优先级 ID
`issue_priority_detail.title`	string	是	否	优先级标题

milestone 对象

字段	类型	必返	可为空	说明
`milestone.created_at`	string	是	否	里程碑创建时间
`milestone.description`	string	是	否	里程碑描述
`milestone.due_on`	string	是	否	里程碑截止日期
`milestone.number`	integer	是	否	里程碑编号
`milestone.repository_id`	integer	是	否	仓库 ID
`milestone.state`	string	是	否	里程碑状态
`milestone.title`	string	是	否	里程碑标题
`milestone.updated_at`	string	是	否	里程碑更新时间
`milestone.url`	string	是	否	里程碑链接

assignee 对象

字段	类型	必返	可为空	说明
`assignee.avatar_url`	string	是	否	用户头像链接
`assignee.html_url`	string	是	否	用户主页链接
`assignee.id`	string	是	否	用户 ID
`assignee.login`	string	是	否	登录名
`assignee.name`	string	是	否	用户名

失败响应¶

该接口无业务失败响应（参考文档未提供失败响应示例），错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`304`	未修改（Not modified）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not Found）
`429`	请求过于频繁（Rate limited）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

示例中的占位符替换规则：

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

此接口允许匿名访问，示例未携带访问令牌；如需认证身份，也可在请求中携带 AtomGit 用户访问令牌。

cURL¶

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

print(resp.json())

响应示例¶

状态码： 200

响应体为 issue 对象数组，以下为其中一条记录的结构示例。

[
  {
    "id": 152642,
    "html_url": "https://api.atomgit.com/dengmengmian/test01/issues/15",
    "number": "15",
    "state": "opened",
    "title": "示例 issue 标题",
    "body": "示例 issue 正文内容",
    "user": {
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "html_url": "https://api.atomgit.com/dengmengmian",
      "id": "661ce4eab470b1430d456154",
      "login": "dengmengmian",
      "name": "麻凡_"
    },
    "repository": {
      "id": 280713,
      "full_name": "dengmengmian / test01",
      "path": "test01",
      "name": "test01",
      "description": "",
      "created_at": "2024-04-15T16:27:45.090+08:00",
      "updated_at": "2024-04-15T16:27:45.090+08:00",
      "assigner": null,
      "paas": null
    },
    "created_at": "2024-04-18T14:35:15.479+08:00",
    "updated_at": "2024-04-20T15:20:30.111+08:00",
    "finished_at": null,
    "labels": [
      {
        "id": 382379,
        "name": "bug",
        "color": "#428BCA",
        "created_at": "2024-04-18T10:00:00.000+08:00",
        "updated_at": "2024-04-18T10:00:00.000+08:00"
      }
    ],
    "issue_state": "opened",
    "comments": 3,
    "priority": 1,
    "issue_type": "bug",
    "issue_state_detail": {
      "title": "开启",
      "serial": 1,
      "id": 1
    },
    "issue_type_detail": {
      "title": "缺陷",
      "id": 1,
      "is_system": true
    },
    "issue_priority_detail": {
      "id": "1",
      "title": "高"
    },
    "milestone": {
      "created_at": "2024-04-18T10:00:00.000+08:00",
      "description": "示例里程碑",
      "due_on": "2024-05-01T00:00:00.000+08:00",
      "number": 1,
      "repository_id": 280713,
      "state": "open",
      "title": "v1.0",
      "updated_at": "2024-04-18T10:00:00.000+08:00",
      "url": "https://api.atomgit.com/dengmengmian/test01/milestones/1"
    },
    "assignee": {
      "avatar_url": "https://api.atomgit.com/avatar.png",
      "html_url": "https://api.atomgit.com/dengmengmian",
      "id": "661ce4eab470b1430d456154",
      "login": "dengmengmian",
      "name": "麻凡_"
    },
    "visibility_reason": "public"
  }
]

错误码¶

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

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