列出看板项目¶
- 接口地址:
/api/kanban/project/list
- HTTP请求方式
GET
- 请求参数
无(需登录)
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/kanban/project/list"
响应示例:
JSON:
{ "code": 0, "message": "", "data": { "list": [ { "name": "", "id": "", "creator_id": "", "team_id": "", "color": "", "icon": "", "icon_color": "", "name_color": "", }, ], "uid": "1234567890", "email": "hello@example.com", }, }
创建看板项目¶
- 接口地址:
/api/kanban/project/create
- HTTP请求方式
POST
- 请求参数
name (form, required): 项目名称
team_id (form, optional): 团队 ID
after_id (form, optional): 排序后置于其后的项目 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/project/create" -d "name=我的看板"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }
移动看板项目¶
- 接口地址:
/api/kanban/project/move
- HTTP请求方式
POST
- 请求参数
id (form, required): 项目 ID
after_id (form, optional): 移动后置于其后的项目 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/project/move" -d "id=1&after_id=2"
响应示例:
JSON:
{ "code": 0, "message": "OK" }
更新看板项目¶
- 接口地址:
/api/kanban/project/update
- HTTP请求方式
POST
- 请求参数
id (form, required): 项目 ID
name (form, optional): 名称
color (form, optional): 颜色
icon (form, optional): 图标
name_color (form, optional): 名称颜色
icon_color (form, optional): 图标颜色
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/project/update" -d "id=1&name=新名称"
响应示例:
JSON:
{ "code": 0, "message": "OK" }
删除看板项目¶
- 接口地址:
/api/kanban/project/delete
- HTTP请求方式
POST
- 请求参数
id (form, required): 项目 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/project/delete"
响应示例:
JSON:
{ }
创建看板列表¶
- 接口地址:
/api/kanban/list/create
- HTTP请求方式
POST
- 请求参数
name (form, required): 列表名称
project_id (form, required): 项目 ID
after_id (form, optional): 排序后置于其后的列表 ID
before_id (form, optional): 排序后置于其前的列表 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/list/create" -d "name=待办&project_id=1"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }
移动看板列表¶
- 接口地址:
/api/kanban/list/move
- HTTP请求方式
POST
- 请求参数
id (form, required): 列表 ID
after_id (form, optional): 移动后置于其后的列表 ID
before_id (form, optional): 移动后置于其前的列表 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/list/move"
响应示例:
JSON:
{ }
更新看板列表¶
- 接口地址:
/api/kanban/list/update
- HTTP请求方式
POST
- 请求参数
id (form, required): 列表 ID
name (form, optional): 名称
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/list/update" -d "id=1&name=新名称"
响应示例:
JSON:
{ "code": 0, "message": "OK" }
删除看板列表¶
- 接口地址:
/api/kanban/list/delete
- HTTP请求方式
POST
- 请求参数
id (form, required): 列表 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/list/delete"
响应示例:
JSON:
{ }
获取任务列表¶
- 接口地址:
/api/kanban/card/list
- HTTP请求方式
GET
- 请求参数
project_id (query, required): 项目 ID
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/kanban/card/list"
响应示例:
JSON:
{ }
创建任务¶
- 接口地址:
/api/kanban/card/create
- HTTP请求方式
POST
- 请求参数
title (form, required): 卡片标题
list_id (form, required): 列表 ID
color (form, optional): 颜色
due (form, optional): 截止时间
principal_id (form, optional): 负责人 ID
after_id (form, optional): 排序后置于其后的卡片 ID
before_id (form, optional): 排序后置于其前的卡片 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/card/create" -d "title=任务&list_id=1"
响应示例:
JSON:
{ "code": 0, "message": "OK", "data": {} }
获取任务详情¶
- 接口地址:
/api/kanban/card/detail/:id
- HTTP请求方式
GET
- 请求参数
id (path): 卡片 ID
- 响应代码
共通响应
示例:
curl -X GET "$BASE_URL/api/kanban/card/detail/:id"
响应示例:
JSON:
{ }
移动任务¶
- 接口地址:
/api/kanban/card/move
- HTTP请求方式
POST
- 请求参数
id (form, required): 卡片 ID
list_id (form, required): 目标列表 ID
after_id (form, optional): 移动后置于其后的卡片 ID
before_id (form, optional): 移动后置于其前的卡片 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/card/move"
响应示例:
JSON:
{ }
更新任务¶
- 接口地址:
/api/kanban/card/update
- HTTP请求方式
POST
- 请求参数
id (form, required): 卡片 ID
title (form, optional): 标题
desc (form, optional): 描述
color (form, optional): 颜色
due (form, optional): 截止时间
principal_id (form, optional): 负责人 ID
status (form, optional): 状态
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/card/update"
响应示例:
JSON:
{ }
删除任务¶
- 接口地址:
/api/kanban/card/delete
- HTTP请求方式
POST
- 请求参数
id (form, required): 卡片 ID
- 响应代码
共通响应
示例:
curl -X POST "$BASE_URL/api/kanban/card/delete" -d "id=1"
响应示例:
JSON:
{ "code": 0, "message": "OK" }
get kanban card assigned¶
- 接口地址:
/api/kanban/card/assigned
- HTTP请求方式
GET
- 请求参数
见实现(我负责的卡片等)
- 响应代码
共通响应
kanban project stream¶
- 接口地址:
/api/kanban/stream/:id
- HTTP请求方式
GET
- 请求参数
id (path): 项目 ID
- 响应代码
SSE 流,Content-Type: text/event-stream