另外几个接口文档

简介: 提供班级与学员信息管理功能,支持班级列表分页查询、添加、修改、删除及详情查看,同时支持学员信息条件查询,涵盖基本信息、班级关联、学历等字段,便于高效管理教学资源。

班级管理
班级列表查询
基本信息
请求路径:/clazzs
请求方式:GET
接口描述:该接口用于班级列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name

黄埔一期
班级名称
begin

2023/1/1
范围匹配的开始时间(结课时间)
end

2023/5/1
范围匹配的结束时间(结课时间)
page

1
分页查询的页码,如果未指定,默认为1
pageSize

10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/clazzs?page=1&pageSize=5
/clazzs?name=java&page=1&pageSize=5
/clazzs?begin=2023-01-01&end=2023-06-30&page=1&pageSize=5
/clazzs?name=java&begin=2023-01-01&end=2023-06-30&page=1&pageSize=5
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
其他信息
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
item 类型: object
|- id
number
非必须
id
|- name
string
非必须
班级名称
|- room
string
非必须
班级教室
|- beginDate
string
非必须
开课时间
|- endDate
string
非必须
结课时间
|- masterId
number
非必须
班主任(员工ID)
|- masterName
string
非必须
班主任姓名(员工姓名)
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
|- status
string
非必须
状态 (未开班、已开班、已结课)
响应数据样例:
删除班级
基本信息
请求路径:/clazzs/{id}
请求方式:DELETE
接口描述:该接口用于删除班级信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
示例
是否必须
备注
id
number
1
必须
班级的ID
请求参数样例:/clazzs/5
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
添加班级
基本信息
请求路径:/clazzs
请求方式:POST
接口描述:该接口用于添加班级信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
name
string
必须
班级名称
room
string
必须
班级教室
beginDate
string
必须
开课时间
endDate
string
必须
结课时间
masterId
number
非必须
班主任
subject
number
必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
根据ID查询
基本信息
请求路径:/clazzs/{id}
请求方式:GET
接口描述:该接口用于根据主键ID查询班级的信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
班级ID
请求参数样例:/clazzs/8
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- id
number
必须
id
|- name
string
必须
班级名称
|- room
string
必须
班级教室
|- beginDate
string
必须
开课时间
|- endDate
string
必须
结课时间
|- masterId
number
必须
班主任(员工ID)
|- subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
|- createTime
string
必须
创建时间
|- updateTime
string
必须
更新时间
响应数据样例:
修改班级
基本信息
请求路径:/clazzs
请求方式:PUT
接口描述:该接口用于修改班级的数据信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
id
number
必须
id
name
string
必须
班级名称
room
string
必须
班级教室
beginDate
string
必须
开课时间
endDate
string
必须
结课时间
masterId
number
必须
班主任ID(员工ID)
subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
查询所有班级
基本信息
请求路径:/clazzs/list
请求方式:GET
接口描述:该接口用于查询所有班级信息
请求参数

响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object[]
非必须
返回的数据
|- id
number
非必须
id
|- name
string
非必须
班级名称
|- room
string
非必须
班级教室
|- beginDate
string
非必须
开课时间
|- endDate
string
非必须
结课时间
|- masterId
number
非必须
班主任(员工ID)
|- subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例:
学员管理
学员列表查询
基本信息
请求路径:/students
请求方式:GET
接口描述:该接口用于学员列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name

张三
学员姓名
degree

1
学历(1:初中,2:高中,3:大专,4:本科,5:硕士,6:博士)
clazzId

2
班级ID
page

1
分页查询的页码,如果未指定,默认为1
pageSize

10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/students?page=1&pageSize=5
/students?name=张&page=1&pageSize=5
/students?name=张&degree=1&clazzId=2&page=1&pageSize=5
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
|- id
number
非必须
id
|- name
string
非必须
姓名
|- no
string
非必须
学号
|- gender
number
非必须
性别(1: 男 , 2: 女)
|- phone
string
非必须
手机号
|- degree
number
非必须
学历(1:初中,2:高中,3:大专,4:本科,5:硕士,6:博士)
|- idCard
string
非必须
身份证号
|- isCollege
number
非必须
是否是院校学生 (1: 是, 0: 否)
|- address
string
非必须
联系地址
|- graduationDate
string
非必须
毕业时间
|- violationCount
number
非必须
违纪次数
|- violationScore
number
非必须
违纪扣分
|- clazzId
number
非必须
班级ID
|- clazzName
string
非必须
班级名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例:

相关文章
|
算法 测试技术 数据处理
【C/C++ 面试技巧】如何在简单的项目里突出自己的价值?
【C/C++ 面试技巧】如何在简单的项目里突出自己的价值?
432 1
|
存储 Kubernetes 负载均衡
K8S原理和实践
K8S原理和实践
698 0
|
资源调度 JavaScript
vue3 vant上传图片
vue3 vant上传图片
775 0
|
3月前
|
人工智能 自然语言处理 Cloud Native
AI时代代码开发(DeepSeek+Cursor+Devbox)
AI时代重塑软件开发,本课程聚焦DeepSeek+Cursor+Devbox+Sealos工具链,实现自然语言到代码的零基础全栈开发。覆盖需求分析、数据库设计、编码测试至云部署全流程,助力开发者高效构建并上线项目,抢占智能开发先机。(238字)
|
3月前
|
人工智能 Java 程序员
SpringAI+DeepSeek大模型应用开发
本教程以SpringAI为核心,讲解Java与大模型(如DeepSeek)融合开发,助力传统应用智能化升级。适合Java程序员入门AI开发,推动企业低成本拥抱AI变革。
|
3月前
|
存储 SQL 人工智能
AI时代代码开发(数据库设计)
本文介绍基于三范式与DDD的数据库设计流程,结合AI工具辅助分析页面原型,通过部门、员工及工作经历模块,演示表结构设计与优化过程,强调人工校验与调整的重要性,最终完成符合业务需求的数据库建模与测试数据构建。
|
3月前
|
XML 自然语言处理 机器人
SpringAI
SpringAI整合全球主流大模型,支持多种技术架构,提供统一开发接口。本文以OpenAI和Ollama为例,详解如何通过SpringAI快速构建对话机器人,涵盖项目搭建、依赖引入与配置,助力开发者高效上手大模型应用开发。
|
自动驾驶 物联网 5G
什么是 5G 以及它如何工作?
【8月更文挑战第23天】
3496 0
|
敏捷开发 架构师 Java
【领域驱动设计专题】一文带领你透视DDD领域驱动模型的本质和设计原理分析指南(基本概念篇)
【领域驱动设计专题】一文带领你透视DDD领域驱动模型的本质和设计原理分析指南(基本概念篇)
493 0
|
运维 安全 Linux
IDC服务器故障排除思路
本文详细介绍了服务器维修流程,包括维修前的工具和备件准备,以及不拆机情况下的初步检查步骤。文中还提供了拆机维修的具体方法,如最小化测试法、替换法和交叉比较法,并针对CPU、主板、内存、硬盘、电源、风扇、网卡及BMC等主要配件的故障排除进行了说明,强调了注意事项,旨在帮助技术人员快速准确地定位并解决问题。
785 13