287 lines
12 KiB
Markdown
287 lines
12 KiB
Markdown
|
# API 端点详细参考
|
|||
|
|
|
|||
|
|
## 快速查询表
|
|||
|
|
|
|||
|
|
### 按功能模块分类
|
|||
|
|
|
|||
|
|
#### 用户认证与管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/user/login/wechat | POST | 微信登录 | ✅ | ✅ |
|
|||
|
|
| /api/admin/login | POST | 管理员登录 | ✅ | ✅ |
|
|||
|
|
| /api/admin/logout | POST | 退出登录 | ✅ | ✅ |
|
|||
|
|
| /api/admin/current | GET | 获取当前用户 | ✅ | ✅ |
|
|||
|
|
| /api/user/info | GET | 获取用户信息 | ✅ | ✅ |
|
|||
|
|
| /api/user/update | PUT | 更新用户信息 | ✅ | ✅ |
|
|||
|
|
| /api/user/bind-phone | POST | 绑定手机号 | ✅ | ✅ |
|
|||
|
|
| /api/user/change-password | PUT | 修改密码 | ✅ | ✅ |
|
|||
|
|
| /api/user/list | GET | 获取用户列表 | ✅ | ✅ |
|
|||
|
|
| /api/user/detail/{id} | GET | 获取用户详情 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 订单管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/order/create | POST | 创建订单 | ✅ | ✅ |
|
|||
|
|
| /api/order/list | GET | 获取订单列表 | ✅ | ✅ |
|
|||
|
|
| /api/order/detail/{id} | GET | 获取订单详情 | ✅ | ✅ |
|
|||
|
|
| /api/order/detail-full/{id} | GET | 获取完整订单详情 | ✅ | ✅ |
|
|||
|
|
| /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} | POST | 申请退款 | ✅ | ✅ |
|
|||
|
|
| /api/order/count | GET | 获取订单统计 | ✅ | ✅ |
|
|||
|
|
| /api/order/mockPay | POST | 模拟支付 | ✅ | ✅ |
|
|||
|
|
| /api/order/status/{id} | PUT | 更新订单状态 | ✅ | ✅ |
|
|||
|
|
| /api/order/verify | POST | 订单验证 | ❌ | ✅ |
|
|||
|
|
| /api/order/scan-verify/{orderId} | POST | 扫码核销 | ❌ | ✅ |
|
|||
|
|
| /api/order/statistics | GET | 订单统计 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
#### 学生档案
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/student/list | GET | 获取学生列表 | ✅ | ✅ |
|
|||
|
|
| /api/student/detail/{id} | GET | 获取学生详情 | ✅ | ✅ |
|
|||
|
|
| /api/student/create | POST | 创建学生档案 | ✅ | ✅ |
|
|||
|
|
| /api/student/update/{id} | PUT | 更新学生档案 | ✅ | ✅ |
|
|||
|
|
| /api/student/delete/{id} | DELETE | 删除学生档案 | ✅ | ✅ |
|
|||
|
|
| /api/student/set-default/{id} | POST | 设置默认学生 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 服务管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/service/list | GET | 获取服务列表 | ✅ | ✅ |
|
|||
|
|
| /api/service/detail/{id} | GET | 获取服务详情 | ✅ | ✅ |
|
|||
|
|
| /api/service/search | GET | 搜索服务 | ✅ | ✅ |
|
|||
|
|
| /api/service/create | POST | 创建服务 | ❌ | ✅ |
|
|||
|
|
| /api/service/update/{id} | PUT | 更新服务 | ❌ | ✅ |
|
|||
|
|
| /api/service/delete/{id} | DELETE | 删除服务 | ❌ | ✅ |
|
|||
|
|
| /api/service/status/{id} | PUT | 更新服务状态 | ❌ | ✅ |
|
|||
|
|
| /api/category/all | GET | 获取所有分类 | ✅ | ✅ |
|
|||
|
|
| /api/category/list | GET | 获取分类列表 | ❌ | ✅ |
|
|||
|
|
| /api/category/create | POST | 创建分类 | ❌ | ✅ |
|
|||
|
|
| /api/category/update/{id} | PUT | 更新分类 | ❌ | ✅ |
|
|||
|
|
| /api/category/delete/{id} | DELETE | 删除分类 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
#### 学习记录
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/record/list | GET | 获取学习记录列表 | ✅ | ✅ |
|
|||
|
|
| /api/record/detail/{id} | GET | 获取学习记录详情 | ✅ | ✅ |
|
|||
|
|
| /api/record/create | POST | 创建学习记录 | ✅ | ✅ |
|
|||
|
|
| /api/record/update | PUT | 更新学习记录 | ✅ | ✅ |
|
|||
|
|
| /api/record/delete/{id} | DELETE | 删除学习记录 | ✅ | ✅ |
|
|||
|
|
| /api/record/stats | GET | 获取学习统计 | ✅ | ✅ |
|
|||
|
|
| /api/record/parent/list | GET | 获取家长学习记录 | ✅ | ✅ |
|
|||
|
|
| /api/record/{id}/feedback | POST | 提交反馈 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 日历与预约
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /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 | GET | 获取未读消息数 | ✅ | ✅ |
|
|||
|
|
| /api/notification/mark-read/{id} | POST | 标记已读 | ✅ | ✅ |
|
|||
|
|
| /api/notification/mark-all-read | POST | 标记全部已读 | ✅ | ✅ |
|
|||
|
|
| /api/notification/delete/{id} | DELETE | 删除通知 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 地址管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/address/list | GET | 获取地址列表 | ✅ | ✅ |
|
|||
|
|
| /api/address/add | POST | 添加地址 | ✅ | ✅ |
|
|||
|
|
| /api/address/update | PUT | 更新地址 | ✅ | ✅ |
|
|||
|
|
| /api/address/delete/{id} | DELETE | 删除地址 | ✅ | ✅ |
|
|||
|
|
| /api/address/default/{id} | PUT | 设置默认地址 | ✅ | ✅ |
|
|||
|
|
| /api/address/default | GET | 获取默认地址 | ✅ | ✅ |
|
|||
|
|
| /api/address/detail/{id} | GET | 获取地址详情 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 钱包与交易
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/wallet/info | GET | 获取钱包信息 | ✅ | ✅ |
|
|||
|
|
| /api/wallet/balance | GET | 查询余额 | ✅ | ✅ |
|
|||
|
|
| /api/wallet/recharge-request | POST | 创建充值请求 | ❌ | ✅ |
|
|||
|
|
| /api/wallet/transaction/list | GET | 获取交易记录 | ❌ | ✅ |
|
|||
|
|
| /api/wallet/transaction/statistics | GET | 获取交易统计 | ❌ | ✅ |
|
|||
|
|
| /api/wallet/transaction/detail/{id} | GET | 获取交易详情 | ❌ | ✅ |
|
|||
|
|
| /api/wallet/transaction/type-statistics | GET | 交易类型统计 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
#### 提现管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/withdraw/apply | POST | 申请提现 | ✅ | ✅ |
|
|||
|
|
| /api/withdraw/list | GET | 获取提现记录 | ✅ | ✅ |
|
|||
|
|
| /api/withdraw/stats | GET | 获取提现统计 | ✅ | ✅ |
|
|||
|
|
| /api/withdraw/audit/{id} | PUT | 审核提现 | ❌ | ✅ |
|
|||
|
|
| /api/withdraw/complete/{id} | PUT | 完成提现 | ❌ | ✅ |
|
|||
|
|
| /api/withdraw/admin/list | GET | 获取所有提现 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
#### 工单管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/workorder/list | GET | 获取工单列表 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/create | POST | 创建工单/派单 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/detail/{id} | GET | 获取工单详情 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/update/{id} | PUT | 更新工单 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/cancel/{id} | POST | 取消工单 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/complete/{id} | POST | 完成工单 | ❌ | ✅ |
|
|||
|
|
| /api/workorder/start/{id} | POST | 开始服务 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
#### 教师管理
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/teacher/list | GET | 获取教师列表 | ✅ | ✅ |
|
|||
|
|
| /api/teacher/detail/{id} | GET | 获取教师详情 | ✅ | ✅ |
|
|||
|
|
| /api/teacher/create | POST | 创建教师 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/update/{id} | PUT | 更新教师 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/audit/{id} | PUT | 审核教师 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/status/{id} | PUT | 更新教师状态 | ❌ | ✅ |
|
|||
|
|
| /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 | GET | 获取可提现金额 | ✅ | ✅ |
|
|||
|
|
| /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 | POST | 申请提现 | ✅ | ✅ |
|
|||
|
|
|
|||
|
|
#### 教师等级
|
|||
|
|
| 端点 | 方法 | 说明 | 前端 | 后端 |
|
|||
|
|
|------|------|------|------|------|
|
|||
|
|
| /api/teacher/level/list | GET | 获取等级列表 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/level/detail/{id} | GET | 获取等级详情 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/level/create | POST | 创建等级 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/level/update/{id} | PUT | 更新等级 | ❌ | ✅ |
|
|||
|
|
| /api/teacher/level/delete/{id} | DELETE | 删除等级 | ❌ | ✅ |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 前端 API 文件映射
|
|||
|
|
|
|||
|
|
### UniApp 前端 (peidu/uniapp/api/)
|
|||
|
|
|
|||
|
|
| 文件 | 主要端点 | 功能 |
|
|||
|
|
|------|---------|------|
|
|||
|
|
| index.js | /api/user, /api/order, /api/student, /api/service, /api/record, /api/calendar | 主要业务 API |
|
|||
|
|
| recordApi.js | /api/record | 学习记录 |
|
|||
|
|
| notification.js | /api/notification, /api/message | 通知消息 |
|
|||
|
|
| calendar.js | /api/calendar | 日历预约 |
|
|||
|
|
| growthRecord.js | /api/growth-record | 成长记录 |
|
|||
|
|
| managerApplication.js | /api/manager/application | 陪伴员申请 |
|
|||
|
|
| operationLog.js | /api/operation-log | 操作日志 |
|
|||
|
|
| permission.js | /api/permission | 权限管理 |
|
|||
|
|
| provider.js | /api/provider | 服务商 |
|
|||
|
|
| reminder.js | /api/reminder | 提醒 |
|
|||
|
|
| review.js | /api/review | 评价 |
|
|||
|
|
| teacherLevel.js | /api/teacher/level | 教师等级 |
|
|||
|
|
| tenant.js | /api/tenant | 租户 |
|
|||
|
|
| withdraw.js | /api/withdraw | 提现 |
|
|||
|
|
| franchise.js | /api/franchise | 加盟 |
|
|||
|
|
| groupBuyApi.js | /api/group-buy | 拼团 |
|
|||
|
|
| export.js | /api/export | 导出 |
|
|||
|
|
| address.js | /api/address | 地址 |
|
|||
|
|
|
|||
|
|
### Admin 前端 (peidu/admin/src/api/)
|
|||
|
|
|
|||
|
|
| 文件 | 主要端点 | 功能 |
|
|||
|
|
|------|---------|------|
|
|||
|
|
| order.js | /order | 订单管理 |
|
|||
|
|
| user.js | /user, /student | 用户和学生管理 |
|
|||
|
|
| teacher.js | /teacher | 教师管理 |
|
|||
|
|
| service.js | /service, /category | 服务和分类管理 |
|
|||
|
|
| system.js | /system, /admin, /permission, /sms, /role | 系统配置 |
|
|||
|
|
| auth.js | /admin/login, /admin/logout, /admin/current | 认证 |
|
|||
|
|
| dashboard.js | /dashboard | 仪表板 |
|
|||
|
|
| statistics.js | /statistics | 统计分析 |
|
|||
|
|
| finance.js | /finance | 财务管理 |
|
|||
|
|
| financial.js | /financial | 财务统计 |
|
|||
|
|
| growth.js | /growth | 成长管理 |
|
|||
|
|
| notification.js | /notification | 通知 |
|
|||
|
|
| chat.js | /chat | 聊天 |
|
|||
|
|
| content.js | /content | 内容管理 |
|
|||
|
|
| assessment.js | /assessment | 考核 |
|
|||
|
|
| article.js | /article | 文章 |
|
|||
|
|
| franchise.js | /franchise | 加盟 |
|
|||
|
|
| groupbuy.js | /group-buy | 拼团 |
|
|||
|
|
| marketing.js | /marketing | 营销 |
|
|||
|
|
| points.js | /points | 积分 |
|
|||
|
|
| training.js | /training | 培训 |
|
|||
|
|
| tutoring.js | /tutoring | 辅导 |
|
|||
|
|
| timecard.js | /timecard | 时卡 |
|
|||
|
|
| tenant.js | /tenant | 租户 |
|
|||
|
|
| teacher-assessment.js | /teacher/assessment | 教师考核 |
|
|||
|
|
| user-tag.js | /user/tag | 用户标签 |
|
|||
|
|
| studytour.js | /study-tour | 研学 |
|
|||
|
|
| summercamp.js | /summer-camp | 暑假营 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 缺失的前端调用
|
|||
|
|
|
|||
|
|
以下后端端点缺少前端调用，建议补充：
|
|||
|
|
|
|||
|
|
### 高优先级（常用功能）
|
|||
|
|
1. /api/order/verify - 订单验证
|
|||
|
|
2. /api/order/scan-verify/{orderId} - 扫码核销
|
|||
|
|
3. /api/order/statistics - 订单统计
|
|||
|
|
4. /api/service/create - 创建服务
|
|||
|
|
5. /api/service/update/{id} - 更新服务
|
|||
|
|
6. /api/service/delete/{id} - 删除服务
|
|||
|
|
7. /api/workorder/* - 所有工单端点
|
|||
|
|
8. /api/teacher/level/* - 所有教师等级端点
|
|||
|
|
|
|||
|
|
### 中优先级（管理功能）
|
|||
|
|
1. /api/wallet/recharge-request - 创建充值请求
|
|||
|
|
2. /api/wallet/transaction/* - 交易记录相关
|
|||
|
|
3. /api/withdraw/audit/{id} - 审核提现
|
|||
|
|
4. /api/withdraw/complete/{id} - 完成提现
|
|||
|
|
5. /api/teacher/create - 创建教师
|
|||
|
|
6. /api/teacher/update/{id} - 更新教师
|
|||
|
|
7. /api/teacher/audit/{id} - 审核教师
|
|||
|
|
|
|||
|
|
### 低优先级（配置功能）
|
|||
|
|
1. /api/service/create - 创建服务
|
|||
|
|
2. /api/category/create - 创建分类
|
|||
|
|
3. /api/category/update/{id} - 更新分类
|
|||
|
|
4. /api/category/delete/{id} - 删除分类
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 使用建议
|
|||
|
|
|
|||
|
|
### 1. 快速查询
|
|||
|
|
使用上面的快速查询表快速找到需要的端点。
|
|||
|
|
|
|||
|
|
### 2. 前后端对接
|
|||
|
|
- 确保前端调用的 URL 与后端定义的路径完全一致
|
|||
|
|
- 检查 HTTP 方法是否匹配（GET/POST/PUT/DELETE）
|
|||
|
|
- 验证请求参数和响应格式
|
|||
|
|
|
|||
|
|
### 3. 新功能开发
|
|||
|
|
- 先在后端实现 API 端点
|
|||
|
|
- 然后在前端创建对应的 API 调用
|
|||
|
|
- 更新此文档以保持同步
|
|||
|
|
|
|||
|
|
### 4. 测试
|
|||
|
|
- 使用 Postman 或类似工具测试所有端点
|
|||
|
|
- 编写集成测试覆盖所有 API 调用
|
|||
|
|
- 验证错误处理和边界情况
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**最后更新**: 2024年
|
|||
|
|
**维护者**: Peidu 开发团队
|