另外几个接口文档

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

班级管理
班级列表查询
基本信息
请求路径:/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
非必须
更新时间
响应数据样例:

相关文章
|
2天前
|
Java API
用链表实现队列/栈
本文介绍如何用链表实现栈和队列,利用双链表头尾操作均为O(1)的特性,通过调用LinkedList API高效实现。栈可选头部或尾部作栈顶,队列同理,只需调整增删位置。文末引出数组实现队列的性能问题,启发优化思考。
|
2天前
|
存储 API 索引
队列/栈基本原理 ❗前置知识
本文介绍队列和栈两种“操作受限”的数据结构:队列遵循先进先出(FIFO),只能队尾入、队头出;栈遵循先进后出(FILO),仅在栈顶进行增删操作。二者底层多由数组或链表实现,核心API包括push、pop、peek和size,是后续复杂数据结构的基础。
|
2天前
|
Java 索引 容器
单/双链表代码实现
本文详解双链表与单链表的 MyLinkedList 实现,重点介绍三个关键优化:1)同时持有头尾节点引用,提升尾部操作效率;2)使用虚拟头尾节点简化边界处理;3)解析链表删除中的内存泄露误区,并强调指针置空的良好编程习惯。
|
1天前
|
存储 缓存 算法
学习数据结构和算法的框架思维
本文系统总结数据结构与算法本质:所有数据结构皆源于数组和链表,核心操作为遍历与访问;算法本质是穷举,关键在于无遗漏、无冗余。文章提炼出通用框架,帮助读者建立计算机思维,掌握高效解题方法,适合初学者建立全局观,也适合进阶者温故知新。
|
1天前
|
缓存 网络协议 算法
核心原理:能否画张图解释下 RPC 的通信流程?
RPC(远程过程调用)是一种实现分布式系统间通信的技术,它让调用远程服务像调用本地方法一样简单。本文深入浅出地讲解了RPC的定义、核心目标、通信流程及在微服务架构中的关键作用,帮助开发者理解其底层原理,掌握如何通过动态代理、序列化、协议设计等机制屏蔽网络复杂性,提升开发效率与系统可维护性。
|
1天前
|
消息中间件 Kubernetes 网络协议
别老想着怎么用好 RPC 框架,你得多花时间琢磨原理
2011年加入京东,亲历技术演进,现任技术架构部首席架构师。主导微服务、消息中间件等核心系统研发,深耕分布式架构。课程涵盖RPC基础、进阶与高级实战,带你掌握网络通信核心,构建高效可靠分布式系统。(238字)
|
1天前
|
算法 Java 索引
双指针技巧秒杀七道数组题目
本文介绍双指针技巧在数组和链表中的应用,重点解析快慢指针如何实现原地修改。通过LeetCode经典题如删除有序数组/链表重复项,展示如何用慢指针记录结果、快指针遍历数据,高效完成去重,时间复杂度O(N),避免频繁数据搬移。
|
1天前
|
算法
双指针技巧秒杀七道链表题目
本文总结单链表七大技巧:合并有序链表、链表分解、合并K个有序链表、找倒数第k个节点、找中点、判断环及起点、判断相交及交点,均基于双指针思想,涵盖LeetCode多道经典题目,助你系统掌握链表算法核心。
|
1天前
|
存储 Java Maven
服务端(DevBox)-项目创建
使用Sealos创建SpringBoot工程zxyf-management,配置Java语言、3.3.2版本,2核CPU、4G内存,通过Devbox在云端搭建开发环境。利用Cursor智能工具打开项目,自动识别Maven结构,一键启动运行,实现高效云端开发。
|
1天前
|
Java
多叉树的递归/层序遍历
多叉树是二叉树的扩展,节点可有多个子节点。遍历方式与二叉树类似,DFS无中序位置,BFS通过队列实现,支持按层遍历并记录深度,代码结构清晰,易于扩展。