如何通过GitLab API创建合并请求评审并实现其增删改查?
合并请求草稿评审API能力说明
完全可以通过GitLab原生API完成合并请求暂存评审(即你观测到的drafts相关接口)的创建、读取、更新、删除全流程操作。
这类接口属于GitLab草稿笔记(Draft Notes)专属能力,因为是网页端前端直接调用的业务接口,并未在早期通用合并请求备注的公开文档中单独列示,请求逻辑和你在浏览器开发者工具中观测到的网页端请求完全对齐,适配GitLab 13.7及以上版本的实例。
核心操作列表
- 读取暂存评审列表
对应接口路径为GET /projects/:id/merge_requests/:merge_request_iid/draft_notes,只要请求用户持有该合并请求的评论权限,就可以拉取自己所有暂存的待发布评审内容,响应结构和你直接向观测到的网页端路径发起GET请求拿到的内容完全一致,包含草稿绑定的代码行位置、文本内容、关联提交SHA等完整字段。 - 创建新的草稿评审
对应接口路径为POST /projects/:id/merge_requests/:merge_request_iid/draft_notes,和你观测到的网页端请求地址完全一致。请求时需要传入草稿的文本内容note,如果是绑定到指定代码行的行内评审,还需要传入对应的差异定位参数(包括关联的提交版本SHA、文件路径、行号等),创建完成的草稿仅对当前登录用户可见,不会同步展示给项目其他协作者。 - 更新已有草稿
对应接口路径为PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id,可以直接修改已暂存草稿的文本内容、调整草稿绑定的代码行位置,不需要重新提交完整的草稿结构。 - 删除草稿
对应接口路径为DELETE /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id,可以直接移除指定的暂存评审内容。 - 配套批量发布能力
可以调用POST /projects/:id/merge_requests/:merge_request_iid/draft_notes/bulk_publish接口,将当前用户所有暂存的草稿一次性转换为正式的合并请求公开评审,和网页端点击「提交评审」的操作逻辑完全匹配。
该接口的鉴权逻辑和GitLab其他公开API完全一致,仅需要在请求头携带匹配权限的个人访问令牌即可,不存在临时调试接口的访问限制,自研应用可以直接对接复用。
内容的提问来源于stack exchange,提问作者brianc
相关产品推荐
相关产品推荐

