后续接口需求清单
文档目的
这份文档用于整理:如果当前 demo 要逐步落成真实项目,后续至少需要哪些后端接口。
这里列的是按业务域整理的接口需求,不是最终协议定义。
1. 用户与身份
接口范围:
- 识别当前用户
- 拉取学员基础资料
- 管理登录态
接口项:
POST /auth/loginPOST /auth/logoutGET /auth/meGET /students/profileGET /students/growth-summary
主要服务页面:
- 首页
- 我的
- 会员中心
2. 课程目录与已报名课程
接口范围:
- 展示课程列表
- 区分可购买课程与已报名课程
- 获取课程详情
接口项:
GET /courses/catalogGET /courses/catalog/:courseIdGET /students/coursesGET /students/courses/:courseId
主要服务页面:
- 课程页
- 课程详情页
- 已报名课程详情页
3. 课表与 lesson
接口范围:
- 获取当前周课表
- 查看 lesson 详情
- 让课表和课程内容对齐
接口项:
GET /schedule/weekGET /schedule/dayGET /courses/:courseId/lessonsGET /courses/:courseId/lessons/:lessonId
主要服务页面:
- 首页课表摘要
- 课表页
- lesson 详情页
4. assessment 与成长记录
接口范围:
- 获取测评列表
- 获取测评详情
- 获取成长数据
接口项:
GET /courses/:courseId/assessmentsGET /courses/:courseId/assessments/:assessmentIdGET /students/growth/radarGET /students/growth/trendGET /students/growth/milestones
主要服务页面:
- 个人中心
- 已报名课程详情
- assessment 详情页
5. 任务与作业
接口范围:
- 获取每日任务
- 标记学习进度
- 提交作业
- 获取作业反馈
接口项:
GET /tasks/dailyPOST /tasks/daily/vocab/:wordId/completePOST /tasks/daily/check-inGET /homeworks/currentPOST /homeworks/:homeworkId/submissionsGET /homeworks/:homeworkId/feedback
主要服务页面:
- 任务页
- 作业页
6. 消息中心
接口范围:
- 获取消息列表
- 获取消息详情
- 标记消息已读
接口项:
GET /notificationsGET /notifications/:notificationIdPOST /notifications/:notificationId/readPOST /notifications/read-all
主要服务页面:
- 消息中心
7. 活动
接口范围:
- 获取活动详情
- 活动报名/取消报名
- 查询当前用户报名状态
接口项:
GET /activitiesGET /activities/:activityIdPOST /activities/:activityId/signupPOST /activities/:activityId/cancelGET /activities/:activityId/registration
主要服务页面:
- 活动页
- 课表页
- 首页活动入口
8. 订单与支付
接口范围:
- 创建订单
- 拉起支付
- 查询支付结果
接口项:
POST /ordersGET /orders/:orderIdPOST /orders/:orderId/payGET /payments/:paymentId/statusGET /students/orders
主要服务页面:
- 课程详情页
- 支付结果页
9. 会员体系
接口范围:
- 获取会员信息
- 获取套餐列表
- 购买/续费会员
接口项:
GET /memberships/currentGET /memberships/plansPOST /memberships/ordersGET /memberships/orders/:orderId
主要服务页面:
- 我的
- 会员中心
10. 后台管理系统未来会依赖的接口域
后续后台接口域包括:
- 学员管理接口
- 教师管理接口
- 课程管理接口
- 排课管理接口
- 活动管理接口
- 通知管理接口
- 订单管理接口
- 会员管理接口
当前接口优先级
如果按真实项目的 MVP 推进,接口顺序如下:
authstudents/profilecourses/catalogstudents/coursesschedule/weeklessonsnotificationsactivitiesordershomeworks
当前说明
这份接口清单是“项目需求层接口”,不是最终接口协议。
后续如果开始真正开发后端,可继续补充两份文档:
- 数据实体设计
- API 字段级契约说明