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

图书管理系统接口文档相关推荐

c语言之bbs管理系统,编写c语言的软件纯C语言编写图书管理系统WORD文档bbszp.doc...
编写c语言的软件纯C语言编写图书管理系统WORD文档bbszp 编写c语言的软件纯C语言编写图书管理系统WORD文档bbszp 导读:就爱阅读网友为您分享以下"纯C语言编写图书管理系统W ...
拉钩教育课程管理系统接口文档
课程管理模块接口文档课程信息模块接口 1. 接口1 查询课程列表信息名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou ...
学生宿舍管理系统接口文档
1.登录控制器 1.1 入口,跳转登录页面请求路径:/login /toLogin 请求方式: GET 请求参数:空 return "login/login"; 1.2 默认入口 ...
js学习总结----crm客户管理系统之项目开发流程和api接口文档
CRM ->客户管理系统 CMS ->内容发布管理系统 ERP ->企业战略信息管理系统 OA -> 企业办公管理系统产品 / UI设计:需求分析,产品定位,市场调查...按 ...
推荐一款接口文档在线管理系统-MinDoc
项目简介 MinDoc 是一款针对IT团队开发的简单好用的文档管理系统. MinDoc 的前身是 SmartWiki 文档系统.SmartWiki 是基于 PHP 框架 laravel 开发的一款文档 ...
MinDoc 接口文档在线管理系统
MinDoc 是一款针对IT团队开发的简单好用的文档管理系统. MinDoc 的前身是 SmartWiki 文档系统.SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统. ...
教育平台项目后台管理系统：接口文档
课程管理模块接口文档课程信息模块接口接口 1:查询课程列表信息名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou_e ...
图书馆管理系统 SRS文档
图书馆管理系统 SRS文档编写人:魏晓日期:2015年05月27日 1介绍 1.1编写目的图书管理系统需求规格说明书是为了让系统的涉众就该系统的需求达成一致认可,明确该系统的需求,为后续的开发工 ...
扔掉Swagger，试试这款功能强大，零注解侵入的API接口文档生成工具！
欢迎关注方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...

图书管理系统接口文档

1,用户界面

1.1 用户登录验证接口

1.2用户注册

1.3密码修改

1.3.1 根据ID查询用户信息

1.3.2 根据ID修改密码

2,页面布局

2.1头部菜单获取

3,用户列表展现

4,用户新增

5,用户修改

5.1根据ID查询用户信息

5.2 根据用户ID更新数据

5.3根据ID删除用户

6,图书分类实现

6.1 查询3级图书分类信息

6.2图书分类新增

6.3图书分类修改

6.4商品分类删除

7图书模块实现

7.1图书列表展现

7.2图书数据删除

7.3图书数据修改

7.3.1根据ID查询图书信息

7.3.2根据图书ID更新数据

8.借还模块实现

8.1借还列表展示

8.2借阅卡信息展现

图书管理系统接口文档相关推荐

最新文章

热门文章