first commit
This commit is contained in:
66
资料/planner_teacher/README.md
Normal file
66
资料/planner_teacher/README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# 规划师项目
|
||||
|
||||
## 项目介绍
|
||||
|
||||
规划师项目是一个帮助教育规划师管理学生和教学流程的系统。系统提供了规划师管理、学生管理、订单管理等功能。
|
||||
|
||||
## 技术栈
|
||||
|
||||
- Spring Boot 3.4.4
|
||||
- MyBatis-Plus 3.5.7
|
||||
- Redis
|
||||
- MySQL
|
||||
- OpenAPI 3.0 (Knife4j)
|
||||
|
||||
## 接口优化
|
||||
|
||||
为提高接口质量和一致性,完成了以下优化:
|
||||
|
||||
1. **统一接口规范**:采用RESTful API设计风格,规范命名
|
||||
2. **API版本控制**:添加`/api/v1`前缀,便于未来升级
|
||||
3. **统一响应格式**:标准化响应结构,使用`ApiResponse`和`PageResponse`
|
||||
4. **全局异常处理**:统一异常处理机制
|
||||
5. **合理分组路径**:优化接口分组和路径结构
|
||||
|
||||
详细的接口设计文档见[README-API.md](./README-API.md)
|
||||
|
||||
## 主要功能
|
||||
|
||||
1. **认证管理**:用户登录、登出
|
||||
2. **规划师管理**:查询和更新规划师信息,查看钱包
|
||||
3. **财务管理**:收支记录、订单管理
|
||||
4. **学生管理**:学生信息CRUD、学生规划进度
|
||||
5. **统计分析**:规划师业绩、学生分布等
|
||||
|
||||
## 快速开始
|
||||
|
||||
1. 克隆项目
|
||||
```bash
|
||||
git clone https://github.com/your-repo/planner_teacher.git
|
||||
```
|
||||
|
||||
2. 配置数据库
|
||||
```yml
|
||||
# application.yml
|
||||
spring:
|
||||
datasource:
|
||||
url: jdbc:mysql://localhost:3306/planner_db
|
||||
username: root
|
||||
password: root
|
||||
```
|
||||
|
||||
3. 启动项目
|
||||
```bash
|
||||
mvn spring-boot:run
|
||||
```
|
||||
|
||||
4. 访问接口文档
|
||||
```
|
||||
http://localhost:8080/doc.html
|
||||
```
|
||||
|
||||
- [ ] 用户服务
|
||||
- 学员
|
||||
- 规划师
|
||||
- [ ] 订单服务
|
||||
-
|
||||
Reference in New Issue
Block a user