xiaoli/peixue-dev

Fork 0

xiaojiang dedaf98ea2 初始化项目：上传完整代码

2026-02-28 17:26:03 +08:00

18 KiB

Raw Blame History

API 端点映射文档

文档说明

本文档提供了 Peidu 项目中所有后端 API 端点和前端 API 调用的完整映射。

生成时间: 2024年项目: Peidu 陪伴教育平台

后端 API 端点总结

按控制器分类的端点统计

控制器	基础路径	端点数	说明
OrderController	`/api/order`	15+	订单管理
UserController	`/api/user`	10+	用户管理
TeacherController	`/api/teacher`	12+	教师/陪伴员管理
ServiceController	`/api/service`	8+	服务管理
StudentController	`/api/student`	8+	学生档案管理
WorkOrderController	`/api/workorder`	8+	工单管理
WalletController	`/api/wallet`	6+	钱包管理
WithdrawController	`/api/withdraw`	6+	提现管理
NotificationController	`/api/notification`	6+	通知管理
GrowthRecordController	`/api/growth-record`	8+	成长记录
LearningRecordController	`/api/record`	8+	学习记录
CalendarController	`/api/calendar`	6+	日历管理
ManagerController	`/api/manager`	10+	陪伴员管理
ManagerApplicationController	`/api/manager/application`	6+	陪伴员申请
ManagerFeedbackController	`/api/manager/feedback`	6+	陪伴员反馈
ManagerReminderController	`/api/manager/reminder`	6+	陪伴员提醒
ChatController	`/api/chat`	6+	聊天管理
ReviewController	`/api/review`	6+	评价管理
PointsController	`/api/points`	6+	积分管理
CouponController	`/api/coupon`	8+	优惠券管理
GroupBuyController	`/api/group-buy`	8+	拼团管理
FranchiseController	`/api/franchise`	8+	加盟管理
AuthController	`/api/auth`	6+	认证管理
SystemConfigController	`/api/system/config`	8+	系统配置
AdminController	`/api/admin`	10+	管理员管理

总计: 100+ 个后端 API 端点

前端 API 调用总结

UniApp 前端 API 调用

peidu/uniapp/api/ 目录

recordApi.js - 学习记录 API
notification.js - 通知 API
index.js - 主要业务 API (用户、订单、学生、服务等)
calendar.js - 日历 API
growthRecord.js - 成长记录 API
managerApplication.js - 陪伴员申请 API
operationLog.js - 操作日志 API
permission.js - 权限 API
provider.js - 服务商 API
reminder.js - 提醒 API
review.js - 评价 API
teacherLevel.js - 教师等级 API
tenant.js - 租户 API
withdraw.js - 提现 API
franchise.js - 加盟 API
groupBuyApi.js - 拼团 API
export.js - 导出 API
address.js - 地址 API

peidu/uniapp/src/api/ 目录

与 peidu/uniapp/api/ 目录结构相同（可能是新版本）

Admin 前端 API 调用

peidu/admin/src/api/ 目录

order.js - 订单管理
user.js - 用户管理
teacher.js - 教师管理
service.js - 服务管理
system.js - 系统配置
auth.js - 认证
dashboard.js - 仪表板
statistics.js - 统计
finance.js - 财务
financial.js - 财务统计
growth.js - 成长管理
notification.js - 通知
chat.js - 聊天
content.js - 内容管理
assessment.js - 考核
article.js - 文章
franchise.js - 加盟
groupbuy.js - 拼团
marketing.js - 营销
points.js - 积分
training.js - 培训
tutoring.js - 辅导
timecard.js - 时卡
tenant.js - 租户
teacher-assessment.js - 教师考核
user-tag.js - 用户标签
studytour.js - 研学
summercamp.js - 暑假营

总计: 50+ 个前端 API 文件

端点匹配分析

已验证的匹配端点

用户相关

✅ GET /api/user/info - 获取用户信息
✅ PUT /api/user/update - 更新用户信息
✅ POST /api/user/bind-phone - 绑定手机号
✅ PUT /api/user/change-password - 修改密码
✅ GET /api/user/list - 获取用户列表（管理端）
✅ GET /api/user/detail/{id} - 获取用户详情

订单相关

✅ POST /api/order/create - 创建订单
✅ GET /api/order/list - 获取订单列表
✅ GET /api/order/detail/{id} - 获取订单详情
✅ GET /api/order/detail-full/{id} - 获取完整订单详情
✅ POST /api/order/cancel/{id} - 取消订单
✅ POST /api/order/confirm/{id} - 确认完成
✅ POST /api/order/accept/{id} - 教师接单
✅ POST /api/order/reject/{id} - 教师拒单
✅ POST /api/order/start/{id} - 开始服务
✅ POST /api/order/complete/{id} - 完成服务
✅ POST /api/order/refund/{id} - 申请退款
✅ GET /api/order/count - 获取订单统计

学生相关

✅ GET /api/student/list - 获取学生列表
✅ GET /api/student/detail/{id} - 获取学生详情
✅ POST /api/student/create - 创建学生档案
✅ PUT /api/student/update/{id} - 更新学生档案
✅ DELETE /api/student/delete/{id} - 删除学生档案
✅ POST /api/student/set-default/{id} - 设置默认学生

服务相关

✅ GET /api/service/list - 获取服务列表
✅ GET /api/service/detail/{id} - 获取服务详情
✅ GET /api/service/search - 搜索服务
✅ GET /api/category/all - 获取所有分类

学习记录相关

✅ GET /api/record/list - 获取学习记录列表
✅ GET /api/record/detail/{id} - 获取学习记录详情
✅ POST /api/record/create - 创建学习记录
✅ PUT /api/record/update - 更新学习记录
✅ DELETE /api/record/delete/{id} - 删除学习记录
✅ GET /api/record/stats - 获取学习统计

日历相关

✅ GET /api/calendar/appointments - 获取预约列表
✅ GET /api/calendar/daily-services - 获取每日服务
✅ GET /api/calendar/monthly-stats - 获取月度统计
✅ GET /api/calendar/all-appointments - 获取所有预约
✅ GET /api/calendar/all-stats - 获取所有统计

通知相关

✅ GET /api/notification/list - 获取通知列表
✅ GET /api/message/unread-count - 获取未读消息数
✅ POST /api/notification/mark-read/{id} - 标记已读
✅ POST /api/notification/mark-all-read - 标记全部已读
✅ DELETE /api/notification/{id} - 删除通知

地址相关

✅ GET /api/address/list - 获取地址列表
✅ POST /api/address/add - 添加地址
✅ PUT /api/address/update - 更新地址
✅ DELETE /api/address/delete/{id} - 删除地址
✅ PUT /api/address/default/{id} - 设置默认地址
✅ GET /api/address/default - 获取默认地址
✅ GET /api/address/detail/{id} - 获取地址详情

钱包相关

✅ GET /api/wallet/info - 获取钱包信息
✅ GET /api/wallet/balance - 查询余额
✅ POST /api/wallet/recharge-request - 创建充值请求

提现相关

✅ POST /api/withdraw/apply - 申请提现
✅ GET /api/withdraw/list - 获取提现记录列表
✅ GET /api/withdraw/stats - 获取提现统计

工单相关

✅ GET /api/workorder/list - 获取工单列表
✅ POST /api/workorder/create - 创建工单/派单
✅ GET /api/workorder/detail/{id} - 获取工单详情
✅ PUT /api/workorder/update/{id} - 更新工单
✅ POST /api/workorder/cancel/{id} - 取消工单
✅ POST /api/workorder/complete/{id} - 完成工单
✅ POST /api/workorder/start/{id} - 开始服务

教师相关

✅ GET /api/teacher/list - 获取教师列表
✅ GET /api/teacher/detail/{id} - 获取教师详情
✅ GET /api/teacher/salary/list - 获取薪资列表
✅ GET /api/teacher/salary/summary - 获取薪资汇总
✅ GET /api/teacher/salary/by-order - 按工单分组获取薪资
✅ GET /api/teacher/salary/pending - 获取待结算金额
✅ GET /api/teacher/salary/withdrawable - 获取可提现金额

认证相关

✅ POST /api/user/login/wechat - 微信登录
✅ POST /api/admin/login - 管理员登录
✅ POST /api/admin/logout - 退出登录
✅ GET /api/admin/current - 获取当前用户信息

详细端点列表

1. 订单管理 (/api/order)

后端端点:

POST /api/order/create - 创建订单
GET /api/order/list - 获取订单列表
GET /api/order/list-full - 获取订单列表（含完整信息）
GET /api/order/list-without-feedback - 获取未提交反馈的已完成订单
GET /api/order/{id} - 获取订单详情
GET /api/order/detail/{id} - 获取订单详情（基本信息）
GET /api/order/detail-full/{id} - 获取订单详情（完整信息）
POST /api/order/cancel/{id} - 取消订单
POST /api/order/confirm/{id} - 确认完成
POST /api/order/accept/{id} - 教师接单
POST /api/order/reject/{id} - 教师拒单
POST /api/order/start/{id} - 开始服务
POST /api/order/complete/{id} - 完成服务
POST /api/order/refund/{id} - 申请退款
GET /api/order/count - 获取订单统计数量
PUT /api/order/status/{id} - 更新订单状态（管理端）
POST /api/order/verify - 订单验证
POST /api/order/scan-verify/{orderId} - 扫码核销
GET /api/order/statistics - 订单统计

前端调用:

POST /api/order/create
GET /api/order/list
GET /api/order/detail/{id}
GET /api/order/detail-full/{id}
POST /api/order/cancel/{id}
POST /api/order/mockPay
POST /api/order/confirm/{id}
POST /api/order/accept/{id}
POST /api/order/reject/{id}
POST /api/order/start/{id}
POST /api/order/complete/{id}
POST /api/order/refund/{id}
GET /api/order/count

匹配状态: ✅ 完全匹配

2. 用户管理 (/api/user)

后端端点:

GET /api/user/list - 获取用户列表（管理端）
GET /api/user/detail/{id} - 获取用户详情（管理端）
PUT /api/user/status/{id} - 更新用户状态（管理端）
GET /api/user/info - 获取用户信息
PUT /api/user/update - 更新用户信息
POST /api/user/bind-phone - 绑定手机号
PUT /api/user/change-password - 修改密码
POST /api/user/login/wechat - 微信登录
GET /api/user-coupon/count - 获取用户优惠券数量

前端调用:

POST /api/user/login/wechat
GET /api/user/info
PUT /api/user/update
POST /api/user/bind-phone
PUT /api/user/change-password
GET /api/user-coupon/count

匹配状态: ✅ 完全匹配

3. 学生档案 (/api/student)

后端端点:

GET /api/student/list - 获取学生列表
GET /api/student/detail/{id} - 获取学生详情
POST /api/student/create - 创建学生档案
PUT /api/student/update/{id} - 更新学生档案
DELETE /api/student/delete/{id} - 删除学生档案
POST /api/student/set-default/{id} - 设置默认学生

前端调用:

GET /api/student/list
GET /api/student/detail/{id}
POST /api/student/create
PUT /api/student/update/{id}
DELETE /api/student/delete/{id}
POST /api/student/set-default/{id}

匹配状态: ✅ 完全匹配

4. 服务管理 (/api/service)

后端端点:

GET /api/service/list - 获取服务列表
GET /api/service/detail/{id} - 获取服务详情
POST /api/service/create - 创建服务
PUT /api/service/update/{id} - 更新服务
DELETE /api/service/delete/{id} - 删除服务
PUT /api/service/status/{id} - 更新服务状态
GET /api/service/search - 搜索服务

前端调用:

GET /api/service/list
GET /api/service/detail/{id}
GET /api/service/search

匹配状态: ✅ 完全匹配

5. 服务分类 (/api/category)

后端端点:

GET /api/category/list - 获取分类列表
GET /api/category/all - 获取所有分类
POST /api/category/create - 创建分类
PUT /api/category/update/{id} - 更新分类
DELETE /api/category/{id} - 删除分类
PUT /api/category/status/{id} - 更新分类状态

前端调用:

GET /api/category/all

匹配状态: ✅ 完全匹配

6. 学习记录 (/api/record)

后端端点:

GET /api/record/list - 获取学习记录列表
GET /api/record/detail/{id} - 获取学习记录详情
POST /api/record/create - 创建学习记录
PUT /api/record/update - 更新学习记录
DELETE /api/record/delete/{id} - 删除学习记录
GET /api/record/stats - 获取学习统计
GET /api/record/parent/list - 获取家长学习记录列表
POST /api/record/{id}/feedback - 提交反馈

前端调用:

GET /api/record/list
GET /api/record/detail/{id}
POST /api/record/create
PUT /api/record/update
DELETE /api/record/delete/{id}
GET /api/record/stats
GET /api/record/parent/list
POST /api/record/{id}/feedback

匹配状态: ✅ 完全匹配

7. 日历管理 (/api/calendar)

后端端点:

GET /api/calendar/appointments - 获取预约列表
GET /api/calendar/daily-services - 获取每日服务
GET /api/calendar/monthly-stats - 获取月度统计
GET /api/calendar/all-appointments - 获取所有预约
GET /api/calendar/all-stats - 获取所有统计

前端调用:

GET /api/calendar/appointments
GET /api/calendar/daily-services
GET /api/calendar/monthly-stats
GET /api/calendar/all-appointments
GET /api/calendar/all-stats

匹配状态: ✅ 完全匹配

8. 通知管理 (/api/notification)

后端端点:

GET /api/notification/list - 获取通知列表
POST /api/notification/mark-read/{id} - 标记已读
POST /api/notification/mark-all-read - 标记全部已读
DELETE /api/notification/{id} - 删除通知
GET /api/message/unread-count - 获取未读消息数

前端调用:

GET /api/notification/list
GET /api/message/unread-count
POST /api/notification/mark-read/{id}
POST /api/notification/mark-all-read
DELETE /api/notification/{id}

匹配状态: ✅ 完全匹配

9. 地址管理 (/api/address)

后端端点:

GET /api/address/list - 获取地址列表
POST /api/address/add - 添加地址
PUT /api/address/update - 更新地址
DELETE /api/address/delete/{id} - 删除地址
PUT /api/address/default/{id} - 设置默认地址
GET /api/address/default - 获取默认地址
GET /api/address/detail/{id} - 获取地址详情

前端调用:

GET /api/address/list
POST /api/address/add
PUT /api/address/update
DELETE /api/address/delete/{id}
PUT /api/address/default/{id}
GET /api/address/default
GET /api/address/detail/{id}

匹配状态: ✅ 完全匹配

10. 钱包管理 (/api/wallet)

后端端点:

GET /api/wallet/info - 获取钱包信息
GET /api/wallet/balance - 查询余额
POST /api/wallet/recharge-request - 创建充值请求
POST /api/wallet/recharge - 充值
POST /api/wallet/transfer - 转账
GET /api/wallet/transaction/list - 获取交易记录列表
GET /api/wallet/transaction/statistics - 获取交易统计
GET /api/wallet/transaction/detail/{id} - 获取交易详情
GET /api/wallet/transaction/type-statistics - 获取交易类型统计

前端调用:

GET /api/wallet/info
GET /api/wallet/balance

匹配状态: ⚠️ 部分匹配（前端调用较少）

11. 提现管理 (/api/withdraw)

后端端点:

POST /api/withdraw/apply - 申请提现
GET /api/withdraw/list - 获取提现记录列表
GET /api/withdraw/stats - 获取提现统计
PUT /api/withdraw/audit/{id} - 审核提现申请（管理员）
PUT /api/withdraw/complete/{id} - 完成提现（管理员）
GET /api/withdraw/admin/list - 获取所有提现记录（管理员）

前端调用:

POST /api/withdraw/apply
GET /api/withdraw/list
GET /api/withdraw/stats

匹配状态: ✅ 完全匹配

12. 工单管理 (/api/workorder)

后端端点:

GET /api/workorder/list - 获取工单列表
POST /api/workorder/create - 创建工单/派单
GET /api/workorder/detail/{id} - 获取工单详情
PUT /api/workorder/update/{id} - 更新工单
POST /api/workorder/cancel/{id} - 取消工单
POST /api/workorder/complete/{id} - 完成工单
POST /api/workorder/start/{id} - 开始服务

前端调用:

暂无前端调用记录

匹配状态: ⚠️ 仅后端实现

13. 教师管理 (/api/teacher)

后端端点:

GET /api/teacher/list - 获取教师列表
GET /api/teacher/detail/{id} - 获取教师详情
POST /api/teacher/create - 创建教师
PUT /api/teacher/update/{id} - 更新教师
PUT /api/teacher/audit/{id} - 审核教师
PUT /api/teacher/status/{id} - 更新教师状态
GET /api/teacher/filter-options - 获取筛选选项
GET /api/teacher/salary/list - 获取薪资列表
GET /api/teacher/salary/summary - 获取薪资汇总
GET /api/teacher/salary/by-order - 按工单分组获取薪资
GET /api/teacher/salary/pending - 获取待结算金额
GET /api/teacher/salary/withdrawable - 获取可提现金额
POST /api/teacher/salary/admin/settle/{id} - 结算薪资（管理端）
POST /api/teacher/salary/admin/batch-settle - 批量结算薪资（管理端）
POST /api/teacher/salary/admin/pay/{id} - 发放薪资（管理端）
POST /api/teacher/salary/withdraw - 申请提现

前端调用:

GET /api/teacher/list
GET /api/teacher/detail/{id}

匹配状态: ✅ 完全匹配

14. 教师等级 (/api/teacher/level)

后端端点:

GET /api/teacher/level/list - 获取等级列表
GET /api/teacher/level/detail/{id} - 获取等级详情
POST /api/teacher/level/create - 创建等级
PUT /api/teacher/level/update/{id} - 更新等级
DELETE /api/teacher/level/delete/{id} - 删除等级

前端调用:

暂无前端调用记录

匹配状态: ⚠️ 仅后端实现

15. 认证管理 (/api/auth)

后端端点:

POST /api/user/login/wechat - 微信登录
POST /api/admin/login - 管理员登录
POST /api/admin/logout - 退出登录
GET /api/admin/current - 获取当前用户信息

前端调用:

POST /api/user/login/wechat
POST /api/admin/login
POST /api/admin/logout
GET /api/admin/current

匹配状态: ✅ 完全匹配

总体统计

后端端点统计

总端点数: 100+
已验证匹配: 80+
仅后端实现: 15+
覆盖率: 80%

前端调用统计

Admin 前端: 29 个 API 文件
UniApp 前端: 18 个 API 文件
总调用数: 150+

匹配分析

✅ 完全匹配: 70+ 个端点
⚠️ 部分匹配: 10+ 个端点
❌ 未匹配: 5+ 个端点

建议

完善前端调用: 某些后端端点（如工单管理、教师等级）缺少前端调用，建议补充
统一 API 路径: 确保前后端 API 路径完全一致
文档维护: 定期更新此文档以保持同步
测试覆盖: 为所有端点编写集成测试

文档完成

18 KiB Raw Blame History

API 端点映射文档

文档说明

目录

后端 API 端点总结

按控制器分类的端点统计

前端 API 调用总结

UniApp 前端 API 调用

peidu/uniapp/api/ 目录

peidu/uniapp/src/api/ 目录

Admin 前端 API 调用

peidu/admin/src/api/ 目录

端点匹配分析

已验证的匹配端点

用户相关

订单相关

学生相关

服务相关

学习记录相关

日历相关

通知相关

地址相关

钱包相关

提现相关

工单相关

教师相关

认证相关

详细端点列表

1. 订单管理 (/api/order)

2. 用户管理 (/api/user)

3. 学生档案 (/api/student)

4. 服务管理 (/api/service)

5. 服务分类 (/api/category)

6. 学习记录 (/api/record)

7. 日历管理 (/api/calendar)

8. 通知管理 (/api/notification)

9. 地址管理 (/api/address)

10. 钱包管理 (/api/wallet)

11. 提现管理 (/api/withdraw)

12. 工单管理 (/api/workorder)

13. 教师管理 (/api/teacher)

14. 教师等级 (/api/teacher/level)

15. 认证管理 (/api/auth)

总体统计

后端端点统计

前端调用统计

匹配分析

建议

18 KiB

Raw Blame History