提交pull request 评论¶

POST /api/v5/repos/{owner}/{repo}/pulls/{number}/comments

该接口用于向指定的 pull request 提交评论，可指定文件路径与代码所在行数进行行级评论，也可选择文件级评论，提交成功后返回评论 ID 与评论内容。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "body": {
      "description": "评论内容",
      "type": "string"
    },
    "path": {
      "description": "文件的相对路径",
      "type": "string"
    },
    "position": {
      "description": "代码所在行数",
      "type": "integer"
    },
    "position_type": {
      "description": "评论位置类型：\"binary\" 表示文件级评论，\"text\" 表示代码行评论；默认为 \"text\"，传入 \"binary\" 时 position 不再生效",
      "type": "string",
      "enum": ["binary", "text"],
      "default": "text"
    }
  },
  "required": ["body"]
}

响应参数¶

字段	类型	必返	可为空	说明
`id`	string	是	否	评论 ID
`body`	string	是	否	评论内容

失败响应¶

该接口可能返回以下失败响应。错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 body 不能为空"
}

401 未认证

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

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`404`	资源不存在（Not found）
`500`	系统内部错误（Internal server error）

请求示例¶

参数说明¶

示例必须与本文档其余部分自洽，照抄即可调用成功：必填参数一个都不能漏，认证方式与「访问令牌支持说明」一致。占位符含义如下：

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

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/comments?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "建议将这里改为异步处理",
  "path": "src/main/java/com/example/Service.java",
  "position": 120,
  "position_type": "text"
}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/comments?access_token=<token>",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({
      body: "建议将这里改为异步处理",
      path: "src/main/java/com/example/Service.java",
      position: 120,
      position_type: "text",
    }),
  }
);

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

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

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pulls/<number>/comments",
    params={"access_token": "<token>"},
    json={
        "body": "建议将这里改为异步处理",
        "path": "src/main/java/com/example/Service.java",
        "position": 120,
        "position_type": "text",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "id": "97219c08d421e55cfa841deca16a30f5d7269e10",
  "body": "建议将这里改为异步处理"
}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`404`	请求的资源不存在
`500`	系统内部错误

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