feat: 学生信息管理系统开发完成
- 完成学生信息管理核心功能开发 - 新增学生信息采集批次管理功能 - 完成班干部管理模块开发 - 修复物业报修模块附件上传逻辑 - 完善数据库表结构和权限配置 - 更新API文档和变更记录 - 优化前端页面交互体验 详细变更记录见: - docs/变更管理/code-adjust-record-2025-01-13-wuzhen.md - docs/变更管理/code-adjust-record-2025-07-11-wuzilong.md - docs/变更管理/code-adjust-record-2025-07-12-wuzhen.md
This commit is contained in:
commit
8697b21b4d
237 files changed
+35787
-2878
No files matched your search
+35
-23
@@ -1,76 +1,87 @@
|
||||
# 学工管理模块 - API接口
|
||||
|
||||
## 📋 模块说明
|
||||
|
||||
- **模块名称**: 学工管理 (Student Affairs Management)
|
||||
- **模块简称**: xg
|
||||
- **对应后端**: backend/ruoyi-modules/ruoyi-xg/
|
||||
- **对应前端**: web/src/views/xg/
|
||||
|
||||
## 📁 目录结构
|
||||
|
||||
此目录用于存放学工管理模块的所有API接口定义,建议按功能模块细分:
|
||||
|
||||
### 👨🎓 学生管理 (student/)
|
||||
|
||||
- `student/index.ts` - 学生信息管理API
|
||||
- 学生信息、学生档案、学生状态管理
|
||||
|
||||
### 🏠 宿舍管理 (dormitory/)
|
||||
|
||||
- `dormitory/index.ts` - 宿舍管理API
|
||||
- 宿舍分配、宿舍检查、住宿费管理
|
||||
|
||||
### 🎓 班级管理 (class/)
|
||||
|
||||
- `class/index.ts` - 班级管理API
|
||||
- 班级信息、班委管理、班级活动
|
||||
|
||||
### 💰 奖助管理 (scholarship/)
|
||||
|
||||
- `scholarship/index.ts` - 奖助学金管理API
|
||||
- 奖学金、助学金、困难补助管理
|
||||
|
||||
### 📚 德育管理 (moral/)
|
||||
|
||||
- `moral/index.ts` - 德育管理API
|
||||
- 德育评价、违纪处理、综合测评
|
||||
|
||||
### 🎯 活动管理 (activity/)
|
||||
|
||||
- `activity/index.ts` - 活动管理API
|
||||
- 社团活动、文体活动、社会实践
|
||||
|
||||
### 📊 统计分析 (statistics/)
|
||||
|
||||
- `statistics/index.ts` - 学工统计分析API
|
||||
- 学生数据统计、活动统计、综合分析
|
||||
|
||||
## 🎯 API规范
|
||||
|
||||
- 统一使用TypeScript定义接口类型
|
||||
- 请求路径前缀:`/xg/`
|
||||
- 权限编码格式:`xg:功能:操作`
|
||||
- 统一使用request工具发送请求
|
||||
|
||||
## 📝 接口示例
|
||||
|
||||
```typescript
|
||||
// 学生查询接口
|
||||
export interface StudentQuery {
|
||||
pageNum?: number
|
||||
pageSize?: number
|
||||
studentName?: string
|
||||
studentCode?: string
|
||||
classId?: number
|
||||
grade?: string
|
||||
status?: string
|
||||
pageNum?: number;
|
||||
pageSize?: number;
|
||||
studentName?: string;
|
||||
studentCode?: string;
|
||||
classId?: number;
|
||||
grade?: string;
|
||||
status?: string;
|
||||
}
|
||||
|
||||
export interface StudentVO {
|
||||
id: number
|
||||
studentName: string
|
||||
studentCode: string
|
||||
idCard: string
|
||||
classId: number
|
||||
className: string
|
||||
grade: string
|
||||
major: string
|
||||
phone: string
|
||||
email: string
|
||||
dormitoryId?: number
|
||||
dormitoryName?: string
|
||||
status: string
|
||||
createTime: string
|
||||
id: number;
|
||||
studentName: string;
|
||||
studentCode: string;
|
||||
idCard: string;
|
||||
classId: number;
|
||||
className: string;
|
||||
grade: string;
|
||||
major: string;
|
||||
phone: string;
|
||||
email: string;
|
||||
dormitoryId?: number;
|
||||
dormitoryName?: string;
|
||||
status: string;
|
||||
createTime: string;
|
||||
}
|
||||
|
||||
// 获取学生列表
|
||||
@@ -79,13 +90,14 @@ export function listStudent(query: StudentQuery) {
|
||||
url: '/xg/student/list',
|
||||
method: 'get',
|
||||
params: query
|
||||
})
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
## 📝 注意事项
|
||||
|
||||
- 所有接口类型定义需要与后端VO对象保持一致
|
||||
- 分页查询统一使用TableDataInfo响应格式
|
||||
- 非分页接口使用R类型响应格式
|
||||
- 学生个人信息需要严格的隐私保护
|
||||
- 敏感信息如身份证号需要脱敏处理
|
||||
- 敏感信息如身份证号需要脱敏处理
|
||||
@@ -4,7 +4,7 @@
|
||||
* @date 2025-01-23
|
||||
*/
|
||||
|
||||
import request from '@/utils/request'
|
||||
import request from '@/utils/request';
|
||||
|
||||
// 此处导出学工管理模块相关的所有API接口
|
||||
// 示例:
|
||||
@@ -15,4 +15,4 @@ import request from '@/utils/request'
|
||||
// export * from './activity' // 活动管理
|
||||
|
||||
// 临时导出一个空对象,防止编译错误
|
||||
export default {}
|
||||
export default {};
|
||||
Reference in new issue
Block a user