Commit¶
提交是仓库的版本历史单元。通过 API 可以列出与读取提交，对比两个引用、获取 diff 与 patch，查看代码贡献统计，并对提交发表评论。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 提交 | SHA、作者、提交信息、变更统计 | 获取仓库所有提交 |
| 对比 | 两个引用之间的提交与文件差异 | Commits对比 |
| Diff / Patch | 单个提交的差异与补丁内容 | 获取提交差异 |
| 提交评论 | 针对某次提交的评论，可增删改查 | 创建commit评论 |
| 贡献统计 | 按人／按日期的代码新增、删除与提交次数 | 获取代码贡献统计 |
标识方式¶
- 仓库用
owner+repo；提交用sha或ref（分支名、标签名等）标识。 - 对比用
{base}...{head}的省略号形式放在路径里。 - 评论用
id标识；按提交查评论用sha或ref。
常见任务¶
注意事项¶
- 提交本身用复数
/commits/{sha}，而 diff 与 patch 用单数/commit/{sha}/diff（/patch），两个路径族并存。 - 代码贡献统计的路径少了
repos/段：GET /api/v5/{owner}/{repo}/repository/commit_statistics，与其他接口拼法不同。 - 评论有三类入口：按提交
/commits/{sha}/comments（写）、按引用/commits/{ref}/comments（读）、仓库全部/comments（读）；单条评论的读改删统一走/comments/{id}。 - 对比接口的路径必须写成
{base}...{head}（三个点），不是斜杠或两个点。
接口列表¶
本模块共 12 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 获取仓库所有提交 | GET /api/v5/repos/{owner}/{repo}/commits |
该接口用于获取指定仓库的所有提交记录，支持按提交 SHA、文件路径、作者及时间范围进行筛选，并可通过分页方式浏览提交… |
| 2 | 仓库的某个提交 | GET /api/v5/repos/{owner}/{repo}/commits/{sha} |
该接口用于查询指定仓库中某个提交的详细信息，包括提交信息、作者与提交者、变更统计及变更文件列表，可通过 show_d… |
| 3 | Commits对比 | GET /api/v5/repos/{owner}/{repo}/compare/{base}...{head} |
该接口用于查询指定仓库中两个提交之间的对比结果，支持以 Commit SHA、分支名或标签名作为对比起点与终点，返回… |
| 4 | 创建commit评论 | POST /api/v5/repos/{owner}/{repo}/commits/{sha}/comments |
该接口用于在指定仓库的某个 commit 下创建评论，调用时需提供仓库所属空间、仓库路径及 commit ID，并提… |
| 5 | 删除commit评论 | DELETE /api/v5/repos/{owner}/{repo}/comments/{id} |
该接口用于删除指定仓库提交下的评论，调用时需提供仓库所属空间地址、仓库路径及评论 id 以定位目标评论，删除成功后返… |
| 6 | 获取仓库的某条Commit评论 | GET /api/v5/repos/{owner}/{repo}/comments/{id} |
该接口用于获取指定仓库中某条 Commit 评论的详情，返回该评论的内容、创建时间、更新时间、评论目标对象以及发表评… |
| 7 | 更新Commit评论 | PATCH /api/v5/repos/{owner}/{repo}/comments/{id} |
该接口用于更新指定 Commit 上的评论内容。调用时需指定仓库所属空间地址、仓库路径与评论 ID，并通过请求体传入… |
| 8 | 获取仓库的Commit评论 | GET /api/v5/repos/{owner}/{repo}/comments |
该接口用于获取指定仓库的 Commit 评论列表，支持通过页码与每页数量参数进行分页查询，并可选择按评论的升序或降序… |
| 9 | 获取代码量贡献 | GET /api/v5/{owner}/{repo}/repository/commit_statistics |
该接口用于获取指定仓库中某个分支的代码量贡献统计，包括提交记录以及各用户的代码新增与删除行数、提交次数等信息，可通过… |
| 10 | 获取单个commit评论 | GET /api/v5/repos/{owner}/{repo}/commits/{ref}/comments |
该接口用于获取指定仓库中某个 commit 的评论列表，支持分页查询，返回每条评论的内容、创建及更新时间，以及发表评… |
| 11 | 获取commit的diff | GET /api/v5/repos/{owner}/{repo}/commit/{sha}/diff |
该接口用于获取指定仓库中某个 commit 的 diff 内容。通过这个接口，传入仓库所属空间地址、仓库路径及 co… |
| 12 | 获取commit的patch | GET /api/v5/repos/{owner}/{repo}/commit/{sha}/patch |
该接口用于获取指定仓库中某个 commit 的 patch 内容，以 unified diff 格式返回该提交带来的… |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc