获取 issue 关联的 pull requests¶

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

该接口用于获取指定仓库下某个 Issue 关联的所有 Pull Request 列表，返回每个 PR 的编号、标题、状态、源分支与目标分支、指派人员及标签等详细信息；通过 mode 参数可选返回是否可合并的检查结果。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`number`	path	string	是	Issue 编号（区分大小写，无需添加 # 号，须为正整数）
`mode`	query	integer	否	模式，枚举：`0` / `1`；`0`（默认）不返回 mergeable 状态，`1`（增强模式）返回 PR 的 mergeable 状态；默认 `0`

响应参数¶

字段	类型	必返	可为空	说明
`id`	integer	是	否	Pull Request ID
`html_url`	string	是	否	Pull Request 的 HTML 地址
`diff_url`	string	是	否	Pull Request 的 diff 地址
`number`	integer	是	否	Pull Request 编号
`state`	string	是	否	状态，如 `open` / `closed` / `merged`
`title`	string	是	否	Pull Request 标题
`body`	string	是	否	Pull Request 描述
`created_at`	string	是	否	创建时间
`updated_at`	string	是	否	更新时间
`merged_at`	string	是	是	合并时间，未合并时为 `null`
`closed_at`	string	是	是	关闭时间，未关闭时为 `null`
`head`	object	是	否	源分支信息
`base`	object	是	否	目标分支信息
`assignees`	object[]	是	是	指派人员列表
`testers`	object[]	是	是	测试人员列表
`labels`	object[]	是	是	标签列表
`can_merge_check`	boolean	否	是	能否合并的检查结果，`mode=1`（增强模式）时返回

Note: 接口返回的是 pull request 对象数组，上表描述数组中每个元素的字段。

head 对象

字段	类型	必返	可为空	说明
`head.ref`	string	是	否	源分支名称
`head.sha`	string	是	否	源分支最新提交 sha
`head.repo`	object	是	否	源分支所在仓库信息
`head.assigner`	object	否	是	分支指派用户，可为 `null`

`head.repo` 对象¶

字段	类型	必返	可为空	说明
`head.repo.path`	string	是	否	仓库路径
`head.repo.name`	string	是	否	仓库名称
`head.repo.full_name`	string	否	是	仓库完整名称

`head.assigner` 对象¶

字段	类型	必返	可为空	说明
`head.assigner.login`	string	是	否	登录名
`head.assigner.name`	string	是	否	昵称

base 对象

字段	类型	必返	可为空	说明
`base.ref`	string	是	否	目标分支名称
`base.sha`	string	是	否	目标分支最新提交 sha
`base.repo`	object	是	否	目标分支所在仓库信息
`base.assigner`	object	否	是	分支指派用户，可为 `null`

`base.repo` 对象¶

字段	类型	必返	可为空	说明
`base.repo.path`	string	是	否	仓库路径
`base.repo.name`	string	是	否	仓库名称
`base.repo.full_name`	string	否	是	仓库完整名称

`base.assigner` 对象¶

字段	类型	必返	可为空	说明
`base.assigner.login`	string	是	否	登录名
`base.assigner.name`	string	是	否	昵称

assignees / testers 数组元素对象

以下字段同时适用于 assignees 与 testers 数组中的每个元素（字段前缀按所属数组替换）。

字段	类型	必返	可为空	说明
`assignees.id`	string	是	否	用户 ID
`assignees.login`	string	是	否	登录名
`assignees.name`	string	否	是	昵称
`assignees.avatar_url`	string	否	是	头像地址
`assignees.html_url`	string	是	否	用户主页地址

labels 数组元素对象

字段	类型	必返	可为空	说明
`labels.id`	integer	是	否	标签 ID
`labels.color`	string	是	否	标签颜色
`labels.name`	string	是	否	标签名称
`labels.repository_id`	integer	否	是	标签所属仓库 ID
`labels.url`	string	否	是	标签 URL，当前可能为空
`labels.created_at`	string	是	否	创建时间
`labels.updated_at`	string	是	否	更新时间
`labels.text_color`	string	是	否	文本颜色

失败响应¶

除 200 成功响应外，调用方还需了解失败时的返回形态以便编写错误处理。以下示例中的字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数校验失败"
}

404 资源不存在

{
  "error": "not_found",
  "message": "issue 或仓库不存在"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad request）
`404`	资源不存在（Not found）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<number> 替换为 Issue 编号（区分大小写，无需添加 # 号）。该接口允许匿名访问，因此示例未携带访问令牌；如需以登录态调用，可在 URL 上追加 ?access_token=<token>，其中 <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/pull_requests' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues/<number>/pull_requests", {
  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/<number>/pull_requests",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

[
  {
    "id": 67585,
    "html_url": "https://api.atomgit.com/test/test/merge_requests/1",
    "diff_url": "https://api.atomgit.com/test/test/merge_requests/1/diffs",
    "number": 1,
    "state": "open",
    "title": "1",
    "body": "new: 新增文件 test.txt 1",
    "created_at": "2024-04-12T17:50:55.253+08:00",
    "updated_at": "2024-04-20T15:58:30.657+08:00",
    "merged_at": null,
    "closed_at": null,
    "head": {
      "ref": "develop",
      "sha": "061c446d55aae78c7a0f096b2d2dd0d6a1afb170",
      "repo": {
        "path": "paopao1",
        "name": "paopao1"
      },
      "assigner": {
        "login": "test",
        "name": "test"
      }
    },
    "base": {
      "ref": "main",
      "sha": "667d4ac032b2faa13d019753ac218b4f78338273",
      "repo": {
        "path": "paopao1",
        "name": "paopao1"
      },
      "assigner": null
    },
    "assignees": [
      {
        "id": "65803cddcf1e2d1aa3d2e99f",
        "login": "test",
        "name": null,
        "avatar_url": null,
        "html_url": "https://api.atomgit.com/test"
      }
    ],
    "testers": [
      {
        "id": "65803cddcf1e2d1aa3d2e99f",
        "login": "test",
        "name": "test",
        "avatar_url": null,
        "html_url": "https://api.atomgit.com/test"
      }
    ],
    "labels": [
      {
        "id": 383707,
        "color": "#CCCCCC",
        "name": "wontfix",
        "repository_id": null,
        "url": null,
        "created_at": "2024-04-19",
        "updated_at": "2024-04-19",
        "text_color": "#333333"
      }
    ],
    "can_merge_check": true
  }
]

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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