合并Pull Request¶

PUT /api/v5/repos/{owner}/{repo}/pulls/{number}/merge

该接口用于合并指定仓库中指定序号的 Pull Request。支持通过 merge、squash 或 rebase 等方式完成合并，可自定义合并标题与描述，并支持强制合并、扁平化分支合并等选项。合并成功后返回合并提交 SHA 及合并结果信息。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`number`	path	integer	是	第几个 PR，即本仓库 PR 的序数
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 JSON 对象（Content-Type: application/json），也可使用表单提交。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "merge_method": {
      "description": "合并 PR 的方法：merge（合并所有提交）、squash（扁平化分支合并）和 rebase（变基并合并）。默认为 merge。",
      "type": "string",
      "enum": ["merge", "squash", "rebase"],
      "default": "merge"
    },
    "title": {
      "description": "合并标题",
      "type": "string"
    },
    "description": {
      "description": "合并描述",
      "type": "string"
    },
    "force_merge": {
      "description": "是否强制合并",
      "type": "boolean"
    },
    "squash": {
      "description": "是否扁平化分支合并，默认 `false`",
      "type": "boolean",
      "default": false
    },
    "squash_commit_message": {
      "description": "扁平化分支合并的描述",
      "type": "string"
    }
  },
  "required": []
}

响应参数¶

字段	类型	必返	可为空	说明
`sha`	string	否	是	合并成功后产生的提交 SHA
`merged`	boolean	是	否	是否合并成功
`message`	string	是	是	合并结果信息

失败响应¶

除成功响应外，调用方还需要了解失败时的返回形态。该接口在认证失败、参数错误以及 PR 无法合并时会返回失败响应；其中 405 时的响应体结构与成功响应一致（sha / merged / message）。错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数校验失败或请求体解析失败"
}

401 未认证

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

405 PR 无法合并

{
  "sha": null,
  "merged": false,
  "message": "Pull Request 已合并或已关闭。"
}

405 时 message 还可能为「不可自动合并」（存在合并冲突）或后端返回的具体错误信息。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误（Bad Request）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`405`	方法不允许或 PR 无法合并（Method Not Allowed）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径（path）；<number> 替换为 PR 序号；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/merge?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "merge_method": "merge",
    "title": "合并标题",
    "description": "合并描述",
    "force_merge": false,
    "squash": false,
    "squash_commit_message": "扁平化分支合并的描述"
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/merge?access_token=<token>",
  {
    method: "PUT",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      merge_method: "merge",
      title: "合并标题",
      description: "合并描述",
      force_merge: false,
      squash: false,
      squash_commit_message: "扁平化分支合并的描述",
    }),
  },
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/merge",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={
        "merge_method": "merge",
        "title": "合并标题",
        "description": "合并描述",
        "force_merge": False,
        "squash": False,
        "squash_commit_message": "扁平化分支合并的描述",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "sha": "c20ac9624d2811a9313af29769dcf581b60c3044",
  "merged": true,
  "message": "Pull Request 已成功合并"
}

错误码¶

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

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