Redmine API 从 0 到 15 步搞定项目自动化集成的完整指南【免费下载链接】redmineMirror of redmine code source - Official Subversion repository is at https://svn.redmine.org/redmine - contact: vividtone or maeda (at) farend (dot) jp项目地址: https://gitcode.com/GitHub_Trending/re/redmine当你的 CI 流水线需要在构建失败时自动往 Redmine 建一张缺陷单或者你想每天凌晨把昨天的工时数据拉出来画报表时翻代码找入口不如直接用它的 RESTful 接口Redmine 把项目、问题、用户这些核心资源都暴露成了标准的 HTTP 端点GET、POST、PUT、DELETE 四个动词各就各位。这篇文章按我要完成什么任务带你把这条链路走通。30 秒跑通第一个请求先拿到你的 Redmine API 密钥密钥在个人资料的我的 API 密钥里生成。拿到后一条 curl 就能验证通路curl -H X-Redmine-API-Key: your_api_key \ https://redmine.example.com/projects.json看到 HTTP 200 和带total_count、limit、offset元数据的 JSON 数组就说明认证和序列化都通了。列表接口默认一页 25 条这是后面所有批量操作的地基。认证方式怎么选Redmine API 密钥配置与 OAuth2 两条路请求级鉴权逻辑写在 application_controller.rb 里支持三种传法X-Redmine-API-Key头、HTTP Basic用户名 密钥、以及api_key查询参数。团队里怎么选看场景对比项API KeyOAuth2Doorkeeper适用场景服务端脚本、CI 流水线、内部工具面向第三方的应用、需要按 scope 控权配置位置用户资料页生成存环境变量oauth2_applications应用管理见 oauth2_applications_controller.rb优点零配置一行头信息搞定不暴露长期密钥可授权粒度更细缺点密钥泄露即等于账号权限流程重要维护授权端点建议内部自动化 90% 的场景用 API Key 就够了密钥只放环境变量或密钥管理服务别提交进代码库。另外两条底线生产环境走 HTTPS给每个集成账号开独立账号并只授最小角色别拿管理员密钥跑脚本。我想自动建单CI 构建失败时让 Redmine 自己长出一张问题流水线失败后自动建单是最高频的集成端点是POST /issues.jsonissues_test.rb 里有完整的参数对照curl -X POST -H X-Redmine-API-Key: your_api_key \ -H Content-Type: application/json \ https://redmine.example.com/issues.json \ -d { issue: { project_id: 1, tracker_id: 1, subject: 构建失败#20260925-01, description: 流水线日志见附录, priority_id: 4 } }返回 201 且响应体里有id即创建成功。自定义字段要用cf[字段id]这种写法传比如cf[3]: v1.8.2字段 id 在问题表单的 HTML 源码或GET /issues.json的返回结构里都能看到。我想批量更新状态一次巡检改 50 张单该怎么做Redmine 的批量是逐条 REST先按查询条件把问题捞出来再对每条做PUT /issues/:id.json。读出来的对象带上全部字段改完状态整体写回# 1) 捞出目标 curl -H X-Redmine-API-Key: k \ https://redmine.example.com/issues.json?project_id1status_id* # 2) 逐条更新只放要改的字段 curl -X PUT -H X-Redmine-API-Key: k \ -H Content-Type: application/json \ https://redmine.example.com/issues/1234.json \ -d {issue: {status_id: 5}}注意PUT是部分更新语义只传要动的字段即可但改状态可能触发自定义字段必填校验失败时读响应体里的 errors 数组定位别盲目重试。我想拉取数据做报表分页、元数据与时区三件事报表脚本的套路是循环分页 过滤参数。列表接口天然带total_count/limit/offset元数据加上nometa1可以把它省掉curl -H X-Redmine-API-Key: k \ https://redmine.example.com/issues.json?project_id1limit100offset0nometa1拿到limit条就翻下一页直到取满total_count。注意日期在 JSON 里是 ISO8601 带时区XML 里是另一种格式api_test.rb 对两种格式各有一个用例写解析器前先在两种格式下各跑一遍。踩坑清单这些报错都替你试过了406 Not AcceptableAccept 头与服务端格式不匹配URL 上显式写.json并带上Accept: application/json403 Forbidden多半是密钥对应账号没有目标项目的访问权限先确认账号在该项目里是成员自定义字段报不能为空字段没按cf[N]传或者 N 用错了循环拉数据时漏单默认每页只有 25 条忘了翻 offset附件想传上去单字段 JSON 传不了二进制走multipart/form-dataattachments_test.rb 有现成样例进阶与扩展插件端点、分页调参与中转服务插件可以在自己的config/routes.rb里挂新路由routes.rb 末尾会加载plugins/*/config/routes.rb想加自定义端点就从这里入手。批量脚本建议串行 短超时RESTful 接口是同步模型单条请求本来就快瓶颈在总请求数而不是并发度。过滤、聚合逻辑复杂的场景别把循环写死在 CI 里起一个薄壳服务做中转接口细节变了只改一处。想现在就试的话拿你的流水线跑一遍建单 改状态这两步剩下的端点清单可以直接照着 test/integration/api_test/ 里 30 个测试文件对号入座。【免费下载链接】redmineMirror of redmine code source - Official Subversion repository is at https://svn.redmine.org/redmine - contact: vividtone or maeda (at) farend (dot) jp项目地址: https://gitcode.com/GitHub_Trending/re/redmine创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考