校园管理系统接口文档

1.用户登陆

1.1 用户登录验证接口

• 请求路径: /api/login
• 请求方式: POST
• 请求参数

参数名称	参数说明	备注
username	用户名	不能为空
userpwd	密码	不能为空

• 响应数据 SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回密钥token信息

返回值格式如下:

	{"status":200,"msg":"服务器调用成功!","data":"1e893a97634847b3a8b499b173bea620"}
	

2.页面布局

2.1 左侧菜单获取

• 请求路径 /rights/getRightsList
• 请求类型 GET
• 请求参数 无
• 响应数据 SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回权限List集合

响应数据如图所示

3. 作业管理

3.1作业管理列表展现

• 请求路径: /user/task/list
• 请求类型: GET
• 请求参数: 后台使用PageResultUser对象接收
• 请求案例: http://localhost:8091/user/list?query=查询关键字&pageNum=1&pageSize=10

参数名称	参数说明	备注信息
query	用户查询的数据	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

• 响应参数: SysResult对象 需要携带分页对象 PageResultUser

参数名称	参数说明	备注信息
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回值PageResult对象

• PageResultUser 对象介绍

参数名称	参数类型	参数说明	备注信息
query	String	用户查询的数据	可以为null
pageNum	Integer	查询页数	不能为null
pageSize	Integer	查询条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

• 返回值效果

{"status":200,
  "msg":"服务器调用成功!",
  "data":
	{"query":"",
	"pageNum":1,
	"pageSize":2,
	"total":4,
	"rows":[
		{"created":"2021-02-18T11:17:23.000+00:00",
		 "updated":"2021-03-26T06:47:20.000+00:00",
		 "id":1,
		 "username":"admin",
		 "password":"a66abb5684c45962d887564f08346e8d",
		 "phone":"13111112222",
		 "email":"1235678@qq.com",
		 "status":true,
		 "role":null
		 },
		{"created":"2021-02-18T11:17:23.000+00:00",
		"updated":"2021-03-13T08:50:30.000+00:00",
		"id":2,
		"username":"admin123",
		"password":"a66abb5684c45962d887564f08346e8d",
		"phone":"13111112223",
		"email":"1235678@qq.com",
		"status":false,
		"role":null
		}
		]
	}
}

3.2.作业状态修改

• 请求路径 /user/task/{id}
• 请求类型 GET

  参数名称	参数类型	参数说明	备注信息
  id	Integer	用户ID号	不能为null
  status	boolean	参数状态信息	不能为null

• 返回值: SysResult对象

{"status":200,"msg":"服务器调用成功!","data":null}

3.3. 作业新增

• 请求路径 /user/addTask
• 请求类型 POST
• 请求参数: 整个form表单数据封装为js对象进行参数传递

参数名称	参数类型	参数说明	备注信息
class	String	班级	不能为null
subject	String	科目	不能为null
task	String	作业	不能为null
completionstatus	String	完成情况	不能为null

• 返回值结果: SysResult对象

{"status":200,"msg":"服务器调用成功!","data":null}

4. 教职工管理

4.1 教职工列表展现

• 请求路径: /teacher/list
• 请求类型: GET
• 请求参数: 后台使用PageResultTeacher对象接收
• 请求案例: http://localhost:8091/user/list?query=查询关键字&pageNum=1&pageSize=10

参数名称	参数说明	备注信息
query	用户查询的数据	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

• 返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分类参数List集合

• PageResultTeacher 对象介绍

参数名称	参数类型	参数说明	备注信息
query	String	用户查询的数据	可以为null
pageNum	Integer	查询页数	不能为null
pageSize	Integer	查询条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

响应数据如图所示

4.2新增教职工

• 请求路径 /teacher/addTeacher
• 请求类型 POST
• 请求参数: 整个form表单数据封装为js对象进行参数传递

参数名称	参数类型	参数说明	备注信息
teachername	String	教师名	不能为null
subject	String	所教科目	不能为null
class	String	所教班级	不能为null
phone	String	电话号码	不能为null

• 返回值结果: SysResult对象

{"status":200,"msg":"服务器调用成功!","data":null}

4.3根据ID修改教职工信息

• 请求路径: /teacher/updateTeacher
• 请求类型: PUT
• 请求参数: User对象结构

参数名称	参数说明	备注
ID	教师ID号	不能为null
subject	所教科目	不能为null
class	所教班级	不能为null

• 返回值: SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	null

• JSON格式如下

{
 "status":200,
 "msg":"服务器调用成功!",
 "data":{}
 }

4.4根据ID删除教师(解聘教师)

• 请求路径: /teacher/{id}
• 请求类型: delete
• 请求参数:

参数名称	参数说明	备注
ID	用户ID号	不能为null

• 返回值: SysResult对象

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	null

4.5教师状态修改(是否请假)

• 请求路径 /teacher/status/{id}/{status}
• 请求类型 PUT
• 请求参数: 用户ID/状态值数据

参数名称	参数类型	参数说明	备注信息
id	Integer	用户ID号	不能为null
status	boolean	参数状态信息	不能为null

• 返回值结果: SysResult对象

{"status":200,"msg":"服务器调用成功!","data":null}

5.课程管理

5.1课程列表展现

• 请求路径: /curriculum/getcurriculumList?query=&pageNum=1&pageSize=10
• 请求类型: get
• 请求参数: 使用pageResult对象接收

参数名称	参数说明	备注信息
query	用户查询的数据	可以为null
pageNum	分页查询的页数	必须赋值不能为null
pageSize	分页查询的条数	必须赋值不能为null

• 返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	商品分页对象

5.2 删除课程

• 请求路径: /curriculum/deletecurriculumById
• 请求类型: delete
• 请求参数:

参数名称	参数说明	备注
id	商品id	不能为null

• 返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	可以为null

5.3课程封面上传

• 请求路径: http://localhost:8091/picture/upload
• 请求类型: post
• 请求参数:

参数名称	参数说明	备注
file	文件上传的参数名称	file中携带的是二进制信息

• 返回值结果:

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
msg	服务器返回的提示信息	可以为null
data	服务器返回的业务数据	返回ImageVO对象

• ImageVO对象说明

参数名称	参数类型	参数说明	备注
virtualPath	Spring	图片实际路径 不包含磁盘信息	例如: 2021/11/11/a.jpg 不需要写磁盘地址
urlPath	Spring	图片url访问地址	http://image.jt.com/2021/11/11/a.jpg 需要指定域名地址
fileName	Spring	文件上传后的文件名称	UUID.type