图书管理系统接口文档

1,用户界面

1.1 用户登录验证接口

• 请求路径:/user/login

• 请求方式:POST

• 请求参数

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

• 响应数据 SysResult对象

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

1.2用户注册

• 请求路径:/user/newUser
• 请求方式:PSOT
• 请求参数

参数名称	参数说明	备注
username	用户名	不能为空
password	密码	不能为空
phone	电话号	不能为空

响应数据SysResult对象

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

1.3密码修改

1.3.1 根据ID查询用户信息

• 请求路径:/user/{id}
• 请求方式:get
• 返回值:SysResult对象

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

1.3.2 根据ID修改密码

• 请求路径:/user/updateUserPassword
• 请求方式:put
• 请求参数:

参数名称	参数说明	备注
ID	用户ID号	不能为null
OldPassword	旧密码	不能为null
NewPassword	新密码	不能为null

返回值:SysResult对象

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

2,页面布局

2.1头部菜单获取

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

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

3,用户列表展现

• 请求路径: /user/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	服务器返回的业务数据	可以null

• PageResult 对象介绍

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

4,用户新增

• 请求路径 /user/addUser
• 请求类型 POST
• 请求参数: 整个form表单数据

参数名称	参数类型	参数说明	备注信息
username	String	用户名	不能为null
password	String	密码	不能为null
phone	String	电话号码	不能为null
email	String	密码	不能为null

返回值结果:SysResult

5,用户修改

5.1根据ID查询用户信息

• 请求路径: /user/{id}
• 请求类型: GET
• 返回值: SysResult对象

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

5.2 根据用户ID更新数据

• 请求路径: /user/updateUser
• 请求类型: PUT
• 请求参数:

参数名称	参数说明	备注
ID	用户ID号	不能为null
phone	手机信息	不能为null
email	邮箱地址	不能为null

• 返回值: SysResult对象

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

5.3根据ID删除用户

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

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

返回值: SysResult对象

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

6,图书分类实现

6.1 查询3级图书分类信息

• 请求路径: /classInfo/findClassInfoList/{level}
• 请求类型: get
• 请求参数: level

参数名称	参数说明	备注
level	查询级别	1查询一级分类 2查询1-2 级图书分类 3查询1-2-3级图书分类

• 业务说明: 查询3级分类菜单数据 要求三层结构嵌套
• 返回值: SysResult对象

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

6.2图书分类新增

• 请求路径: /classInfo/saveClassInfo
• 请求类型: post
• 请求参数: 表单数据

参数名称	参数说明	备注
name	图书分类名称	不能为null
parentId	用户父级ID	不能为null
level	分类级别	1 2 3 图书分类级别

• 返回值: SysResult对象

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

6.3图书分类修改

• 请求路径: /classInfo/updateClassInfo
• 请求类型: put
• 请求参数: 表单数据 ItemCat对象
• 返回值:SysResult对象

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

6.4商品分类删除

• 请求路径: /classInfo/deleteClassInfo
• 请求类型: delete
• 业务描述: 当删除节点为父级时,应该删除自身和所有的子节点
• 请求参数:

参数名称	参数说明	备注
id	用户id号	不能为null
level	图书分类级别 一级,二级,三级

• 返回值结果 SysResult对象

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

7图书模块实现

7.1图书列表展现

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

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

• 返回值结果:

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

7.2图书数据删除

• 请求路径: /bookInfo/deleteBookInfoByID
• 请求类型: delete
• 请求参数:

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

• 返回值结果:

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

7.3图书数据修改

7.3.1根据ID查询图书信息

• 请求路径: /bookInfo/{id}
• 请求类型: GET
• 返回值: SysResult对象

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

7.3.2根据图书ID更新数据

• 请求路径: /bookinfo/updateBookInfo
• 请求类型: PUT
• 请求参数:

参数名称	参数说明	备注
ID	图书ID	不能为null
name	书名	不能为null
author	作者	不能为null
publish	出版社	不能为null
ISBN	标准书号	不能为null
introduction	间接	不能为null
language	语言	不能为null
price	价格	不能为null
pub_date	出版时间	不能为null
class_id	分类号	不能为null
number	剩余	不能为null

• 返回值: SysResult对象

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

8.借还模块实现

8.1借还列表展示

• 请求路径: /lendList/findlLendList
• 请求类型: get
• 返回值:SysResult对象

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

8.2借阅卡信息展现

• 请求路径: /lendList/findReaderCard
• 请求类型: get
• 返回值:SysResult对象

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