项目业务接口文档

用户登录验证接口

• 请求路径: /user/login

• 请求方式: POST

• 请求参数:

参数名称	参数说明	备注
name	用户名	不能为null
password	密码	不能为null

•响应数据SysResult对象

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

用户列表展现

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

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

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

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

• PageResult 对象介绍

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

完成用户注册

• 请求路径: /user/register
• 请求类型: POST
• 请求参数: 对象的JSON串. {key:value}

 数据库入库信息

响应数据 SysResult对象

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

4.查询所有的用户信息

• 请求路径: /user/findAll
• 请求类型: GET
• 请求参数: 

 响应数据 SysResult对象

参数名称	参数说明	备注
name	用户名	不为null
book	该用户借书的书名	不为null
time	该用户借书的时间	不为null

根据用户名查询对应的用户信息

• 请求路径: /user/{name}
• 请求类型: GET
• 业务：模糊查询name="%xxx%"数据
• 返回类型：List<User>
• 请求参数: name属性

响应数据 SysResult对象

参数名称	参数说明	备注
name	用户名	不为null
book	该用户借书的书名	不为null
time	该用户借书的时间	不为null

 根据用户名删除数据

• 请求路径: /user/{id}
• 请求类型: DELETE
• 请求参数

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

响应数据 SysResult对象

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

根据id查询用户信息

• 请求路径: /user/{id}
• 请求类型: GET
• 请求参数: 

• 返回值: SysResult对象

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

实现用户修改操作

• 请求路径: /user/updateUser
• 请求类型: PUT
• 请求参数: js对象 对象的json串

返回值: SysResult对象

return new SysResult(200,"业务执行成功",null); 

根据id更改用户状态信息

• 请求路径: /user/status/{id}/{status}
• 请求类型: PUT
• 请求参数:2个参数 用对象接收

响应数据 SysResult对象

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

 用户权限列表展现

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

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

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

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

• PageResult 对象介绍

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

 根据phone查看用户信息

• 请求路径: /userRole/getRoleInfoByPhone/{phone}
• 请求类型: GET
• 请求参数: 

响应数据 SysResult对象

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

 新增用户信息

• 请求路径: /userRole/addUserRole

• 请求方式: POST

• 请求参数:

参数名称	参数说明	备注
name	用户名	不能为null
password	密码	不能为null

•响应数据SysResult对象

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

修改用户状态

• 请求路径: /userRole/status/{userId}/{status}
• 请求类型: put
• 请求参数:

参数名称	参数说明	备注
userId	用户ID值	不能为null
status	商品状态信息	不能为null

• 返回值: SysResult对象

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

 查看用户权限信息

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

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

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

• 请求路径:/role/list
• 请求类型: GET
• 请求参数: 后台使用PageResult对象接收
• 请求案例: http://localhost:8091/user/list?query=查询关键字&pageNum=1&pageSize=10
• 响应参数: SysResult对象 需要携带分页对象 PageResult
• PageResult 对象介绍

 根据用户ID查询结果

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

• 请求路径:/role/getRoleByRid
• 请求类型: GET
• 返回值: SysResult对象

 左边菜单获取

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

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

 文件上传业务接口

• 请求路径: /file/upload
• 请求类型: post
• 请求参数:

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

• 返回值结果:

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

 

文件删除业务接口

• 请求路径: file/deleteFile
• 请求类型: DELETE
• 请求参数:

参数名称	参数说明	备注
virtualPath	文件上传的虚拟的路径	删除时需要磁盘路径一起删除

• 返回值结果:

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

根据用户id绑定书籍id借阅书籍

url：/book/borrow/{user_id}/{book_id}
请求类型: POST
请求参数：userId bookId 用 borrow对象接收
返回值 SysResult(borrow)对象

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

 查询图书列表

• 请求类型: GET
• 请求路径: /book/getBookList?query=&pageNum=1&pageSize=10
• 请求参数: 后台使用PageResult对象接收

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

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

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

• PageResult 对象介绍

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

图书状态修改

• 请求路径:/book/updateBookStatus
• 请求类型: put
• 请求参数:

参数名称	参数说明	备注
userId	用户ID值	不能为null
status	商品状态信息	不能为null

• 返回值: SysResult对象

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

 图书删除操作 

• 请求路径: /book/deleteItemById
• 请求类型: delete
• 请求参数:

参数名称	参数说明	备注
id	图书id	不能为null

• 返回值结果:

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

实现图书分类删除操作

*URL: /bookCat/deleteBookCat?id=xxx

• 请求类型: delete
• 请求参数: bookCat对象

响应数据 SysResult对象

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

 查询公告列表

URL地址:/anno/getAnnoList?query=&pageNum=1&pageSize=10
请求类型: get
* 参数: pageResult对象
* 返回值: SysResult(pageResult)

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

返回值参数

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

公告根据ID删除操作

* URL:  /anno/deleteAnnoById

* 请求类型: delete
* 参数: id
* 返回值: SysResult对象

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