当前位置:   article > 正文

图书管理系统接口文档_java图书管理系统中用户接口有哪些

java图书管理系统中用户接口有哪些

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 对象介绍
参数名称参数类型参数说明备注信息
queryString用户查询的数据可以为null
pageNumInteger查询页数不能为null
pageSizeInteger查询条数不能为null
totalLong查询总记录数不能为null
rowsObject分页查询的结果

不能为null

4,用户新增

  • 请求路径 /user/addUser
  • 请求类型 POST
  • 请求参数: 整个form表单数据
参数名称参数类型参数说明备注信息
usernameString用户名不能为null
passwordString密码不能为null
phoneString电话号码不能为null
emailString密码不能为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

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/310718
推荐阅读
相关标签
  

闽ICP备14008679号