docs: 更新目标模块相关文档
This commit is contained in:
+83
@@ -523,6 +523,89 @@ POST /api/config/test
|
||||
|
||||
---
|
||||
|
||||
## 目标管理 API
|
||||
|
||||
### GET /api/goals
|
||||
获取所有目标
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "掌握基本音阶",
|
||||
"content": "...",
|
||||
"created_at": "2026-04-23T10:00:00",
|
||||
"updated_at": "2026-04-23T10:00:00"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### POST /api/goals
|
||||
创建新目标
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"name": "目标名称",
|
||||
"content": "目标内容(Markdown)"
|
||||
}
|
||||
```
|
||||
|
||||
### GET /api/goals/{id}
|
||||
获取单个目标
|
||||
|
||||
### PUT /api/goals/{id}
|
||||
更新目标
|
||||
|
||||
### DELETE /api/goals/{id}
|
||||
删除目标
|
||||
|
||||
### GET /api/goals/{id}/children
|
||||
获取目标的子目标
|
||||
|
||||
### GET /api/goals/{id}/parents
|
||||
获取目标的父目标
|
||||
|
||||
### POST /api/goals/{id}/children
|
||||
添加子目标关联(含循环检测)
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"child_goal_id": 2
|
||||
}
|
||||
```
|
||||
|
||||
### DELETE /api/goals/{id}/children/{child_id}
|
||||
移除子目标关联
|
||||
|
||||
## 学员目标 API
|
||||
|
||||
### GET /api/students/{id}/goals
|
||||
获取学员的所有目标
|
||||
|
||||
### POST /api/students/{id}/goals
|
||||
为学员分配目标
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"goal_id": 1,
|
||||
"status": "未开始",
|
||||
"mastery_level": 1,
|
||||
"deadline": "2026-05-01"
|
||||
}
|
||||
```
|
||||
|
||||
### PUT /api/students/{id}/goals/{goal_id}
|
||||
更新学员目标状态/掌握程度
|
||||
|
||||
### DELETE /api/students/{id}/goals/{goal_id}
|
||||
移除学员的目标
|
||||
|
||||
---
|
||||
|
||||
## 权限说明
|
||||
|
||||
| 接口 | 管理员 | 普通用户 |
|
||||
|
||||
Reference in New Issue
Block a user