Redmine API 技能

通过 Redmine REST API 管理项目和问题。

配置

在使用前，需要在工作区的 TOOLS.md 或环境变量中配置：

REDMINE_URL=https://your-redmine-server.com
REDMINEAPIKEY=your-api-key

核心功能

1. 查询问题列表

bash

基本查询

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \
$REDMINE_URL/issues.json?limit=25 | jq

按项目查询

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINEURL/issues.json?projectid=PROJECT_ID | jq

按状态查询 (open/closed/*)

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINEURL/issues.json?statusid=open | jq

指派给我的

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINEURL/issues.json?assignedto_id=me | jq

2. 获取单个问题详情

bash
curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \
$REDMINEURL/issues/ISSUEID.json?include=journals,attachments | jq

include 可选值：children, attachments, relations, changesets, journals, watchers

3. 创建问题

bash
curl -s -X POST -H X-Redmine-API-Key: $REDMINEAPIKEY \
-H Content-Type: application/json \
$REDMINE_URL/issues.json \
-d {
issue: {
project_id: 1,
tracker_id: 1,
subject: 问题标题,
description: 问题描述,
priority_id: 2,
assignedtoid: 123
}
} | jq

4. 更新问题

bash
curl -s -X PUT -H X-Redmine-API-Key: $REDMINEAPIKEY \
-H Content-Type: application/json \
$REDMINEURL/issues/ISSUEID.json \
-d {
issue: {
status_id: 3,
notes: 更新备注
}
}

5. 获取项目列表

bash
curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \
$REDMINE_URL/projects.json | jq

6. 获取元数据

bash

状态列表

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \
$REDMINEURL/issuestatuses.json | jq

跟踪标签列表

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINE_URL/trackers.json | jq

优先级列表

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINEURL/enumerations/issuepriorities.json | jq

用户列表

curl -s -H X-Redmine-API-Key: $REDMINEAPIKEY \ $REDMINE_URL/users.json | jq

常用脚本

使用 scripts/redmine.py 进行操作：

bash

查询我的问题

python3 scripts/redmine.py my-issues

查询项目问题

python3 scripts/redmine.py issues --project PROJECT_ID

获取问题详情

python3 scripts/redmine.py get ISSUE_ID

创建问题

python3 scripts/redmine.py create --project PROJECT_ID --subject 标题 --description 描述

更新问题状态

python3 scripts/redmine.py update ISSUEID --status STATUSID --notes 备注

分页

默认返回 25 条，最大 100 条：

• - offset: 跳过的条数
• limit: 返回条数

响应包含 total_count, offset, limit 字段。

自定义字段

查询：cf_X=value（X 为自定义字段 ID）
创建/更新：

json
{
issue: {
custom_fields: [
{id: 1, value: 值1}
]
}
}

认证方式

1. 1. API 密钥（推荐）：X-Redmine-API-Key 请求头
2. HTTP 基本认证

错误处理

• - 422: 验证错误
• 401: 认证失败
• 403: 权限不足
• 404: 资源不存在