127 lines
5.6 KiB
Markdown
127 lines
5.6 KiB
Markdown
# App端接口接入情况分析
|
||
|
||
## 一、已接入的接口
|
||
|
||
### 1. 课程相关
|
||
- ✅ `GET /study/course/my-courses` - 获取当前学员的课程列表(页面直接调用)
|
||
- ✅ `GET /study/course/app/{id}` - 获取课程详情(页面直接调用)
|
||
|
||
### 2. 考试相关
|
||
- ✅ `GET /study/exam/student/my-exams` - 获取当前学生的考试列表(exam.js)
|
||
- ✅ `GET /study/exam/{id}/questions` - 获取考试题目(exam.js)
|
||
- ✅ `GET /study/exam/{id}` - 获取考试信息(exam.js)
|
||
|
||
### 3. 成绩相关
|
||
- ✅ `GET /study/score/my-scores` - 获取当前学生的成绩列表(score.js)
|
||
- ✅ `GET /study/score/{id}` - 获取成绩详情(score.js)
|
||
- ✅ `POST /study/score/submit` - 提交答题结果(exam.js)
|
||
|
||
### 4. 学科相关
|
||
- ✅ `GET /study/subject/app/list` - 获取学科分类列表(subject.js)
|
||
- ✅ `GET /study/subject/{id}` - 获取学科分类详情(subject.js)
|
||
|
||
### 5. 学习记录相关
|
||
- ✅ `GET /study/learningRecord/my-records` - 获取当前学员的学习记录(页面直接调用)
|
||
- ✅ `POST /study/learningRecord/progress` - 上报学习进度(progressQueue.js)
|
||
|
||
### 6. 语音评测相关
|
||
- ✅ `POST /study/voiceEvaluation/uploadAndEvaluate` - 上传音频并进行评测(voiceEvaluation.js)
|
||
- ✅ `GET /study/voiceEvaluation/my-records` - 获取我的语音评测记录(voiceEvaluation.js)
|
||
- ✅ `GET /study/voiceEvaluation/{id}` - 获取语音评测详情(voiceEvaluation.js)
|
||
|
||
### 7. 课件相关
|
||
- ✅ `GET /study/courseware/app/list` - 获取课程课件列表(页面直接调用)
|
||
- ✅ `GET /study/courseware/{id}` - 获取课件详情(页面直接调用)
|
||
|
||
### 8. 班级用户相关(教师端)
|
||
- ✅ `GET /study/classUser/students/{classId}` - 根据班级ID获取学生列表(teacher.js)
|
||
- ✅ `GET /study/classUser/allStudents` - 获取所有学生(teacher.js)
|
||
|
||
### 9. 教师端其他接口
|
||
- ✅ `GET /study/exam/my-exams` - 获取我的考试列表(教师端,teacher.js)
|
||
- ✅ `GET /study/course/my-courses` - 获取我的课程列表(教师端,teacher.js)
|
||
- ✅ `GET /study/score/list` - 获取学生成绩列表(teacher.js)
|
||
- ✅ `GET /study/learningRecord/student/{studentId}` - 获取学生学习记录(teacher.js)
|
||
|
||
---
|
||
|
||
## 二、已接入的接口(新增)
|
||
|
||
### 1. 课程相关 ✅
|
||
**接口:** `GET /study/course/my-courses` - 已封装到 `course.js`
|
||
**接口:** `GET /study/course/app/{id}` - 已封装到 `course.js`
|
||
**接口:** `GET /study/course/{id}` - 已封装到 `course.js`(可选)
|
||
|
||
### 2. 学习记录相关 ✅
|
||
**接口:** `GET /study/learningRecord/my-records` - 已封装到 `learningRecord.js`
|
||
**接口:** `POST /study/learningRecord/progress` - 已封装到 `learningRecord.js`
|
||
**接口:** `GET /study/learningRecord/course/{courseId}` - 已封装到 `learningRecord.js`
|
||
**接口:** `GET /study/learningRecord/statistics` - 已封装到 `learningRecord.js`
|
||
|
||
### 3. 课件相关 ✅
|
||
**接口:** `GET /study/courseware/app/list` - 已封装到 `courseware.js`
|
||
**接口:** `GET /study/courseware/{id}` - 已封装到 `courseware.js`
|
||
|
||
### 4. 班级用户相关 ✅
|
||
**接口:** `GET /study/classUser/students/{classId}` - 已封装到 `classUser.js`
|
||
**接口:** `GET /study/classUser/teachers/{classId}` - 已封装到 `classUser.js`
|
||
**接口:** `GET /study/classUser/allStudents` - 已封装到 `classUser.js`
|
||
**接口:** `GET /study/classUser/allTeachers` - 已封装到 `classUser.js`
|
||
**接口:** `GET /study/classUser/student/{studentId}/classes` - 已封装到 `classUser.js`
|
||
|
||
### 5. 教师端接口 ✅
|
||
**接口:** `GET /study/classUser/teachers/{classId}` - 已添加到 `teacher.js`
|
||
**接口:** `GET /study/classUser/allTeachers` - 已添加到 `teacher.js`
|
||
**接口:** `GET /study/learningRecord/course/{courseId}` - 已添加到 `teacher.js`
|
||
**接口:** `GET /study/learningRecord/statistics` - 已添加到 `teacher.js`
|
||
|
||
---
|
||
|
||
## 三、建议
|
||
|
||
### 1. 接口封装完成 ✅
|
||
所有接口已统一封装到 `api/study/` 目录下的对应文件中:
|
||
- ✅ `course.js` - 课程相关接口
|
||
- ✅ `learningRecord.js` - 学习记录相关接口(包括统计接口)
|
||
- ✅ `courseware.js` - 课件相关接口
|
||
- ✅ `classUser.js` - 班级用户相关接口
|
||
- ✅ `teacher.js` - 教师端接口(已更新)
|
||
|
||
### 2. 页面更新完成 ✅
|
||
已更新以下页面使用封装的API:
|
||
- ✅ `pages/course/list.vue` - 使用 `course.js` 和 `learningRecord.js`
|
||
- ✅ `pages/course/detail.vue` - 使用 `course.js`、`courseware.js` 和 `learningRecord.js`
|
||
- ✅ `pages/index/index.vue` - 使用 `course.js` 和 `learningRecord.js`
|
||
- ✅ `pages/learning/record.vue` - 使用 `learningRecord.js` 和 `course.js`
|
||
|
||
### 3. 接口调用方式
|
||
- ✅ 所有接口已封装,通过 `import` 导入使用
|
||
- ✅ 统一的调用方式和错误处理
|
||
- ✅ 统一的loading提示配置
|
||
|
||
---
|
||
|
||
## 四、总结
|
||
|
||
**已接入接口数量:** 约 30+ 个
|
||
**未接入接口数量:** 0 个
|
||
**接入完成度:** 100% ✅
|
||
|
||
**所有后端App端可用接口已全部接入!**
|
||
|
||
### 新增的API文件:
|
||
1. ✅ `api/study/course.js` - 课程相关接口(3个)
|
||
2. ✅ `api/study/learningRecord.js` - 学习记录相关接口(4个)
|
||
3. ✅ `api/study/courseware.js` - 课件相关接口(2个)
|
||
4. ✅ `api/study/classUser.js` - 班级用户相关接口(5个)
|
||
5. ✅ `api/study/teacher.js` - 教师端接口(已更新,新增4个)
|
||
|
||
### 更新的页面文件:
|
||
1. ✅ `pages/course/list.vue` - 使用封装的API
|
||
2. ✅ `pages/course/detail.vue` - 使用封装的API
|
||
3. ✅ `pages/index/index.vue` - 使用封装的API
|
||
4. ✅ `pages/learning/record.vue` - 使用封装的API
|
||
|
||
所有接口已统一封装,代码更加规范和易于维护!
|
||
|