docs: 更新目标和学员目标数据模型文档
This commit is contained in:
+55
-4
@@ -585,6 +585,29 @@ POST /api/config/test
|
||||
### GET /api/students/{id}/goals
|
||||
获取学员的所有目标
|
||||
|
||||
**响应**:
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"student_id": 1,
|
||||
"goal_id": 1,
|
||||
"goal_name": "掌握基本音阶",
|
||||
"goal_level": "入门",
|
||||
"goal_category": "演奏能力",
|
||||
"status": "进行中",
|
||||
"start_date": "2026-04-01T00:00:00",
|
||||
"assessment_date": "2026-05-01T00:00:00",
|
||||
"mastery_level": 3,
|
||||
"achievement_date": null,
|
||||
"comment": null,
|
||||
"created_at": "2026-04-01T10:00:00"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
**排序**:按状态(进行中→未开始→已结束),再按评估日期倒序
|
||||
|
||||
### POST /api/students/{id}/goals
|
||||
为学员分配目标
|
||||
|
||||
@@ -592,14 +615,42 @@ POST /api/config/test
|
||||
```json
|
||||
{
|
||||
"goal_id": 1,
|
||||
"status": "未开始",
|
||||
"mastery_level": 1,
|
||||
"deadline": "2026-05-01"
|
||||
"assessment_days": 30,
|
||||
"assessment_date": "2026-05-01",
|
||||
"start_date": "2026-04-01",
|
||||
"start_now": true
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| goal_id | Integer | 目标ID,必填 |
|
||||
| assessment_days | Integer | 评估天数(15/30/60/90/180),与 assessment_date 二选一 |
|
||||
| assessment_date | String | 具体评估日期(ISO格式),与 assessment_days 二选一 |
|
||||
| start_date | String | 开始日期(ISO格式),可选 |
|
||||
| start_now | Boolean | 设为 true 表示立即开始(默认当前时间) |
|
||||
|
||||
### PUT /api/students/{id}/goals/{goal_id}
|
||||
更新学员目标状态/掌握程度
|
||||
更新学员目标
|
||||
|
||||
**请求体**:
|
||||
```json
|
||||
{
|
||||
"start_date": "2026-04-01",
|
||||
"assessment_date": "2026-05-01",
|
||||
"mastery_level": 4,
|
||||
"achievement_date": "2026-05-01",
|
||||
"comment": "表现优秀,已掌握"
|
||||
}
|
||||
```
|
||||
|
||||
| 字段 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| start_date | String | 开始日期(ISO格式) |
|
||||
| assessment_date | String | 评估日期(ISO格式) |
|
||||
| mastery_level | Integer | 掌握程度 1-5 |
|
||||
| achievement_date | String | 达成日期(ISO格式) |
|
||||
| comment | String | 评语 |
|
||||
|
||||
### DELETE /api/students/{id}/goals/{goal_id}
|
||||
移除学员的目标
|
||||
|
||||
Reference in New Issue
Block a user