另外几个接口文档

班级管理
班级列表查询
基本信息
请求路径：/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 非必须 状态 （未开班、已开班、已结课）
响应数据样例：
{
"code": 1,
"msg": "success",
"data": {
"total": 6,
"rows": [
{
"id": 7,
"name": "黄埔四期",
"room": "209",
"beginDate": "2023-08-01",
"endDate": "2024-02-15",
"masterId": 7,
"createTime": "2023-06-01T17:51:21",
"updateTime": "2023-06-01T17:51:21",
"masterName": "纪晓芙",
"status": "已开班"
},
{
"id": 6,
"name": "JavaEE就业166期",
"room": "105",
"beginDate": "2023-07-20",
"endDate": "2024-02-20",
"masterId": 20,
"createTime": "2023-06-01T17:46:10",
"updateTime": "2023-06-01T17:46:10",
"masterName": "陈友谅",
"status": "未开班"
}
]
}
}
删除班级
基本信息
请求路径：/clazzs/{id}
请求方式：DELETE
接口描述：该接口用于删除班级信息
请求参数
参数格式：路径参数
参数说明：
参数名 类型 示例 是否必须 备注
id number 1 必须 班级的ID
请求参数样例：/clazzs/5
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
添加班级
基本信息
请求路径：/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:嵌入式
请求数据样例：
{
"name": "JavaEE就业166期",
"room": "101",
"beginDate": "2023-06-01",
"endDate": "2024-01-25",
"masterId": 7,
"subject": 1
}
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
根据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 必须 更新时间
响应数据样例：
{
"code": 1,
"msg": "success",
"data": {
"id": 8,
"name": "JavaEE就业166期",
"room": "101",
"beginDate": "2023-06-01",
"endDate": "2024-01-25",
"masterId": 7,
"subject": 1,
"createTime": "2023-06-04T17:37:45",
"updateTime": "2023-06-04T17:37:45"
}
}
修改班级
基本信息
请求路径：/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:嵌入式
请求数据样例：
{
"id": 8,
"name": "JavaEE就业166期",
"room": "101",
"beginDate": "2023-06-01",
"endDate": "2024-01-25",
"masterId": 7,
"subject": 1
}
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
查询所有班级
基本信息
请求路径：/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 非必须 更新时间
响应数据样例：
{
"code": 1,
"msg": "success",
"data":[
{
"id": 7,
"name": "黄埔四期",
"room": "209",
"beginDate": "2023-08-01",
"endDate": "2024-02-15",
"masterId": 7,
"subject": 1,
"createTime": "2023-06-01T17:51:21",
"updateTime": "2023-06-01T17:51:21"
},
{
"id": 6,
"name": "JavaEE就业166期",
"room": "105",
"beginDate": "2023-07-20",
"endDate": "2024-02-20",
"masterId": 20,
"subject": 1,
"createTime": "2023-06-01T17:46:10",
"updateTime": "2023-06-01T17:46:10"
}
]
}
学员管理
学员列表查询
基本信息
请求路径：/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 非必须 更新时间
响应数据样例：
{
"code": 1,
"msg": "success",
"data": {
"total": 5,
"rows": [
{
"id": 3,
"name": "Lily",
"no": "2023001003",
"gender": 2,
"phone": "13309230912",
"degree": 4,
"idCard": "110090110090110090",
"isCollege": 0,
"address": "回龙观东大街110号",
"graduationDate": "2020-07-01",
"violationCount": 2,
"violationScore": 5,
"clazzId": 1,
"createTime": "2023-06-01T18:35:23",
"updateTime": "2023-06-01T19:37:42",
"clazzName": "黄埔班一期"
},
{
"id": 4,
"name": "Jerry",
"no": "2023001004",
"gender": 1,
"phone": "15309232323",
"degree": 4,
"idCard": "110090110090110090",
"isCollege": 0,
"address": "回龙观东大街110号",
"graduationDate": "2020-07-01",
"violationCount": 1,
"violationScore": 2,
"clazzId": 1,
"createTime": "2023-06-01T18:35:48",
"updateTime": "2023-06-01T19:37:35",
"clazzName": "黄埔班一期"
}
]
}
}
删除学员
基本信息
请求路径：/students/{ids}
请求方式：DELETE
接口描述：该接口用于批量删除学员信息
请求参数
参数格式：路径参数
参数说明：
参数名 类型 示例 是否必须 备注
ids 数组 1 必须 学员的ID数组
请求参数样例：/students/1,2,3
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
添加学员
基本信息
请求路径：/students
请求方式：POST
接口描述：该接口用于添加学员信息
请求参数
参数格式：application/json
参数说明：
名称 类型 是否必须 备注
name string 必须 姓名
no string 必须 学号
gender number 必须 性别
phone string 必须 手机号
degree number 必须 学历(1:初中,2:高中,3:大专,4:本科,5:硕士,6:博士)
clazzId number 必须 班级ID
idCard string 非必须 身份证号
isCollege number 非必须 是否是院校学生 (1: 是, 0: 否)
address string 非必须 联系地址
graduationDate string 非必须 毕业时间
请求数据样例：
{
"name": "阿大",
"no": "2024010801",
"gender": 1,
"phone": "15909091235",
"idCard": "159090912351590909",
"isCollege": 1,
"address": "昌平回龙观",
"degree": 4,
"graduationDate": "2024-01-01",
"clazzId": 9
}
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
根据ID查询
基本信息
请求路径：/students/{id}
请求方式：GET
接口描述：该接口用于根据主键ID查询学员的信息
请求参数
参数格式：路径参数
参数说明：
参数名 类型 是否必须 备注
id number 必须 学员ID
请求参数样例：/students/8
响应数据
参数格式：application/json
参数说明：
名称 类型 是否必须 备注
code number 必须 响应码, 1 成功 , 0 失败
msg string 非必须 提示信息
data object 必须 返回的数据
|- id number 必须 id
|- name string 必须 姓名
|- no string 必须 学号
|- phone string 必须 手机号
|- gender string 必须 性别(1:男, 2:女)
|- 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
|- createTime string 必须 创建时间
|- updateTime string 必须 更新时间
响应数据样例：
{
"code": 1,
"msg": "success",
"data": {
"id": 7,
"name": "Locos",
"no": "2023001010",
"gender": 1,
"phone": "13712345678",
"degree": 5,
"idCard": "110090110090110090",
"isCollege": 0,
"address": "回龙观东大街110号",
"graduationDate": "2020-07-01",
"violationCount": 0,
"violationScore": 0,
"clazzId": 2,
"createTime": "2023-06-04T18:27:27",
"updateTime": "2023-06-04T18:27:27"
}
}
修改学员
基本信息
请求路径：/students
请求方式：PUT
接口描述：该接口用于修改学员的数据信息
请求参数
参数格式：application/json
参数说明：
名称 类型 是否必须 备注
id number 必须 id
name string 必须 姓名
no string 必须 学号
phone string 必须 手机号
gender string 必须 性别(1:男, 2:女)
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
请求数据样例：
{
"id": 7,
"name": "Locos",
"no": "2023001010",
"gender": 1,
"phone": "13712345678",
"degree": 5,
"idCard": "110090110090110090",
"isCollege": 0,
"address": "回龙观东大街110号",
"graduationDate": "2020-07-01",
"violationCount": 0,
"violationScore": 0,
"clazzId": 2
}
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
违纪处理
基本信息
请求路径：/students/violation/{id}/{score}
请求方式：PUT
接口描述：该接口用于修改学员的数据信息
请求参数
参数格式：路径参数
参数说明：
名称 类型 是否必须 备注
id number 必须 学员ID
score number 必须 扣除分数
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据
响应数据样例：
{
"code":1,
"msg":"success",
"data":null
}
其他接口
登录
基本信息
请求路径：/login
请求方式：POST
接口描述：该接口用于员工登录智学云帆-教学管理系统，登录完毕后，系统下发JWT令牌。
请求参数
参数格式：application/json
参数说明：
名称 类型 是否必须 备注
username string 必须 用户名
password string 必须 密码
请求数据样例：
{
"username": "songjiang",
"password": "123456"
}
响应数据
参数格式：application/json
参数说明：
名称 类型 是否必须 备注
code number 必须 响应码, 1 成功 ; 0 失败
msg string 非必须 提示信息
data object 必须 返回的数据
|- id number 必须 员工ID
|- username string 必须 用户名
|- name string 必须 姓名
|- token string 必须 令牌
响应数据样例：
{
"code": 1,
"msg": "success",
"data": {
"id": 2,
"username": "songjiang",
"name": "宋江",
"token": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwidXNlcm5hbWUiOiJzb25namlhbmciLCJleHAiOjE2OTg3MDE3NjJ9.w06EkRXTep6SrvMns3w5RKe79nxauDe7fdMhBLK-MKY"
}
}
备注说明
用户登录成功后，系统会自动下发JWT令牌，然后在后续的每次请求中，都需要在请求头header中携带到服务端，请求头的名称为 token ，值为 登录时下发的JWT令牌。 如果检测到用户未登录，则直接响应 401 状态码 。
文件上传
基本信息
请求路径：/upload
请求方式：POST
接口描述：上传图片接口
请求参数
参数格式：multipart/form-data
参数说明：
参数名称 参数类型 是否必须 示例 备注
file file 是
响应数据
参数格式：application/json
参数说明：
参数名 类型 是否必须 备注
code number 必须 响应码，1 代表成功，0 代表失败
msg string 非必须 提示信息
data object 非必须 返回的数据，上传图片的访问路径
响应数据样例：
{
"code": 1,
"msg": "success",
"data": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-0400.jpg"
}