Codebrag REST API速查手册提交、评论、点赞接口一网打尽【免费下载链接】codebragYour daily code review tool项目地址: https://gitcode.com/gh_mirrors/co/codebragCodebrag 是一款开源的每日代码审查Code Review工具帮你像刷邮件一样轻松完成日常代码评审。本文将为你整理一份Codebrag REST API 速查手册聚焦最常用的三类接口提交Commits、评论Comments与点赞Likes覆盖请求方法、路径参数、分页规则和常见响应无论是接入自动化脚本还是二次开发都能快速上手。Codebrag REST API 概览认证与通用约定在调用任何接口前你需要了解 Codebrag REST API 的三条基础约定基础路径所有接口统一挂在/rest/前缀下见 ScalatraBootstrap.scala 中的挂载配置。认证方式所有接口都需要登录认证未登录会直接返回 401haltIfNotAuthenticated拦截并支持 Remember Me 会话保持。数据格式请求与响应均为 JSON响应默认带no-cache头避免浏览器缓存旧数据。 提交、评论、点赞三类接口都定义在CommitsServlet下它同时混入了CommitsEndpoint、CommentsEndpoint与LikesEndpoint三个 trait挂载路径统一为/rest/commits调用时注意路径组合。提交接口速查三步掌握提交列表与 Diff提交接口由 CommitsEndpoint.scala 定义是所有审查流程的入口。核心参数包括repo仓库名、sha提交哈希、filter过滤条件以及limit、min_sha、max_sha等分页参数。获取待审查提交列表这是最常用的接口展示“今天需要我审阅的提交”方法路径说明GET/rest/commits/:repo?filterto_review获取待审查提交列表GET/rest/commits/:repo?filterall获取全部提交列表分页采用基于 SHA 的游标方式默认每页 7 条DefaultPageLimit。通过min_sha向后翻页、max_sha向前翻页组合limit即可平滑遍历提交历史。查看提交详情与 Diff拿到提交后点击进入 Diff 页面查看具体改动与行内评论方法路径说明GET/rest/commits/:repo/:sha获取提交 Diff 及关联评论该接口返回 Diff 内容、文件变更列表以及已有评论前端渲染成类似下图的审查界面评论区与代码区左右联动。标记提交为已审查审查完成后一键标记提交状态让团队协作更清晰方法路径说明DELETE/rest/commits/:repo/:sha标记单个提交为已审查DELETE/rest/commits/:repo?filterto_review一键标记当前全部待审查提交评论接口速查提交评论与行内评论评论接口由 CommentsEndpoint.scala 定义支持两种评论方式普通评论与行内评论指定文件和行号。添加一条评论方法路径说明POST/rest/commits/:id/comments为提交:id添加评论请求体示例{ body: 这里建议提取为常量, fileName: src/main/scala/Example.scala, lineNumber: 42 }body评论正文必填且不能为空。fileNamelineNumber必须成对出现。只填其一会被拒绝返回 400因为行内评论需要定位到具体代码行两者都不填则视为普通评论。成功响应返回评论对象AddCommentResponse包含评论 ID、作者姓名、作者 ID、正文、发布时间与头像地址方便前端立即渲染新评论。 小技巧行内评论是 Codebrag 最受欢迎的功能评论会直接“钉”在代码行上作者看到 Diff 时能立刻定位问题审查效率翻倍。点赞接口速查点赞与取消点赞点赞接口由 LikesEndpoint.scala 定义操作非常轻量。为提交点赞方法路径说明POST/rest/commits/:id/likes为提交:id点赞请求体同样支持fileName与lineNumber成对出现时表示给某一行代码点赞成功后返回点赞视图LikeView。取消点赞方法路径说明DELETE/rest/commits/:id/likes/:likeId删除指定点赞取消时需要传入点赞记录 IDlikeId缺失该参数会返回 400 错误提示。关联接口补充Followups 跟进列表审查后产生的评论与待办会汇总成 Followups跟进事项由 FollowupsServlet.scala 提供挂载在/rest/followups方法路径说明GET/rest/followups获取当前用户所有跟进事项GET/rest/followups/:id查看单个跟进详情DELETE/rest/followups/:id标记跟进已完成总结快速回顾 Codebrag REST API 核心要点这份Codebrag REST API 速查手册帮你把最常用的三类接口收进口袋提交接口GET /rest/commits/:repo拉列表、GET /rest/commits/:repo/:sha看 Diff、DELETE标记已审查。评论接口POST /rest/commits/:id/comments发评论fileName与lineNumber成对使用可实现行内评论。点赞接口POST /rest/commits/:id/likes点赞、DELETE /rest/commits/:id/likes/:likeId取消点赞。所有接口均需认证、返回 JSON配合 SHA 游标分页即可轻松遍历提交历史。想深入阅读实现细节可以翻看 CommitsEndpoint.scala、CommentsEndpoint.scala 与 LikesEndpoint.scala 三个源码文件接口语义一目了然。现在就去动手对接你的第一个 Codebrag REST API 请求吧【免费下载链接】codebragYour daily code review tool项目地址: https://gitcode.com/gh_mirrors/co/codebrag创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
