API文档总览.md 5.6 KB

API文档总览

核心模块API

学工管理模块API

后勤管理模块API

招生就业模块API

工作流模块API

班级信息管理API

  • 班级信息管理API:包含班级基本信息的增删改查接口
    • 重要更新(2025-07-03): 新增班级时会自动在sys_dept表中创建对应部门记录
    • 支持按学院、专业、年级等条件查询班级
    • 提供班级详情查询和统计接口

核心功能:

  • 班级信息分页查询(支持多条件搜索)
  • 班级信息新增、修改、删除
  • 班级信息导出
  • 学院专业级联查询(通过关联sys_dept表获取学院名称和专业名称)

API基础路径: /classMsg/classMsg

最新更新:

  • 2025-07-23: 修复新增班级时出现的"Invalid bound statement (not found): org.dromara.xg.mapper.XgSysDeptMapper.selectById"错误,在XgSysDeptMapper.xml中添加selectById方法的SQL映射
  • 2025-07-03: 修复前端班级类型(classType)和班级状态(classStatus)的数据类型处理,确保同时支持字符串和数字类型值的正确显示
  • 2025-07-03: 优化接口返回班级信息表的所有字段,增强数据完整性;通过关联sys_dept表获取collegeName和majorName字段,减少前端接口调用

详细文档: 班级信息管理API.md

宿舍管理员信息API

  • 宿舍管理员信息API:包含宿舍管理员信息的增删改查接口
    • 支持不同类型宿舍管理员(全校管理员、自定义管理员、班主任)的管理
    • 提供获取可用教职工信息的接口,支持选择教职工作为宿舍管理员
    • 新增功能: 在添加管理员时,通过下拉选择可用教师,支持模糊搜索,并自动填充选中教师的手机号码和性别信息

核心功能:

  • 宿舍管理员信息分页查询(支持多条件搜索)
  • 宿舍管理员信息新增、修改、删除
  • 宿舍管理员信息导出
  • 获取可用教职工信息列表(排除已经成为指定类型管理员的人员)
  • 教师选择下拉搜索组件,支持模糊搜索和自动填充数据

API基础路径: /xgStudentManager/studentManager

最新更新:

  • 2025-07-25: 优化管理员添加界面,将姓名输入框改为可搜索的下拉选择框,选择后自动填充教师信息
  • 2025-07-24: 完成宿舍管理员信息管理模块的API接口设计
  • 2025-07-24: 添加获取可用的教职工信息列表接口,支持根据管理员类型筛选可用教职工

详细文档: 宿舍管理员信息API.md

企业信息管理API

  • 企业信息管理API:包含企业信息、招聘岗位、招聘海报生成相关接口
    • 支持企业基本信息的增删改查
    • 支持针对每个企业录入多个招聘岗位信息
    • 支持生成企业招聘海报和岗位招聘海报,并导出为图片或PDF

核心功能:

  • 企业信息的完整管理(支持按名称、行业等条件查询)
  • 招聘岗位的录入和管理(支持设置有效期或永久有效)
  • 基于模板生成招聘海报(企业海报和岗位海报)
  • 海报导出为图片或PDF格式

API基础路径: /zsjy/enterprise、/zsjy/position、/zsjy/poster

最新更新:

  • 2023-07-05: 完成企业信息管理模块的数据库设计和API接口设计
  • 2023-07-05: 添加企业规模、所属行业、岗位有效期类型等数据字典

详细文档: 企业信息管理API.md


📅 最新更新日志

2025-07-24 - 学生信息管理界面重构

  • 界面重构: 学生信息管理新增弹窗调整为多tab页形式
  • 功能增强: 新增照片上传功能,支持完整的学生信息录入
  • 数据扩展: 支持60+个学生信息字段,包括:
    • 基础信息: 学号、身份证号、姓名、性别、出生日期、民族、籍贯、政治面貌、照片等
    • 扩展信息: 文化程度、户口类型、宗教信仰、生源地区、紧急联系人、特殊情况标记等
    • 家庭信息: 父母信息、监护人信息、家庭经济状况等
    • 健康信息: 身高、体重、血型、健康状况、疾病史、过敏史等
    • 学籍信息: 录取类别、学籍状态、入学信息、专业班级、宿舍信息等
    • 银行卡信息: 银行卡号、开户银行等
  • 技术改进: 使用el-tabs组件管理多个表单页面,提升用户体验

2025-07-01 - API文档架构重构

  • 重要重构: 将原本集中的大型API文档按业务模块拆分,提升维护效率
  • 新增: API文档模板,用于新API文档的生成
  • 优化: 目录结构,按功能模块分类管理