试写接口文档

1. 用户登录

1.1 用户登录验证接口

• 请求路径 ：/uers/login

• 请求方式：POST

• 请求参数：username 、 password

  参数名称	参数说明	备注
  username	用户名	！null
  password	密码	！null

  • 响应数据SysResult对象

  ​

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

  返回格式：

  {"status":200,"msg":"服务器成功"，"data":"sdadsadasd"}
  

1.2 左侧菜单获取

• 请求地址：/left/getLeftList

• 方法：get

• 参数：无

• 响应数据SysResult对象

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

status:200,
msg:"服务器成功"，
data：[{
	id:
	name:"用户管理
	parentId:
	path:
	level:
	children:[{
		id:
		name:"用户管理
        parentId:
        path:
        level:
        children:null
        }]
},{
	id:
	name:"商品管理"
	parentId:
	path:
	level:
	children:[{
		id:
		name:"商品管理"
        parentId:
        path:
        level:
        children:null
        }]
},....
]

1.3 用户管理

1.3.1 用户列表展现

（显示所有已注册用户）

• 请求路径：/users/list

• 方法：get

• 参数：无

• 返回值: SysResult对象

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

1.3.1 用户新增

• 路径：/users/addUser

• POST

• 参数：form表单

  名称	类型	说明	备注
  username	string	用户名	! null
  password	string	密码	! null
  phone	number	电话	！null
  address	string	用户地址	！null

  • 返回值结果 ：SysResult

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

1.3.2 用户修改

​ （1）通过ID查询用户信息

• 请求路径 ：/users/{id}
• GET
• 返回值: SysResult对象

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

​ （2）通过ID修改用户信息

• 请求路径：/users/updateUser

• PUT

• 参数：id ，phone，address

  参数名	信息	备注
  id	用户ID	！null
  phone	电话	！null
  address	地址	！null

• 返回值: SysResult对象

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

（3）通过id删除

• 请求路径：/user/{id}
• DELETE
• 参数 id

参数名	信息	备注
id	用户ID	！null

2.图书分类

2.1 查询图书分类信息

• 请求路径：/book/bookType

• GET

• type

  参数名	信息	备注
  type	图书的分类级别	1查询一级分类 2查询二级商品分类 3查询3级商品分类

• 返回值: SysResult对象

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

2.2 图书分类修改

• 请求路径：/book/updateBookType
• PUT
• 参数 ： form表单数据 book对象
• 返回值: SysResult对象

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

2.3 图书分类新增

• 请求路径：/book/savaType

• POST

• 参数：form表单

  参数名称	参数说明	备注
  name	图书分类名	！null
  parentID	图书分类父级id	！null
  level	分类级别	1 2 3级

• 返回值: SysResult对象

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

2.4 图书分类删除

• 请求路径：/book/deleteBookType

• DELETE

• 当删除节点为父级时,应该删除自身和所有的子节点

• 参数：id、level

  参数名称	参数说明	备注
  id	book_tpye id	！null
  level	级别

• 返回值结果 SysResult对象

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

3. 图书管理

3.1 图书列表

• 请求路径 ： /book/getBookList

• GET

• 返回值

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

3.2 图书新增

• 请求路径：/book/addBook

• POST

• 参数：form表单

  参数	说明	备注
  name	图书名	！null
  Type_id	图书类别	！null
  …	等等等	…

3.3 图书修改

通过id先查询得到

• 请求路径：/book/{id}
• GET
• 返回值

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

3.3.1 图书修改

• 请求路径：/book/updateBook

• PUT

• 参数：form表单

• 返回值

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

3.3.2 图书删除

• 请求路径：/book/{id}

• delete

• 参数：id

• 返回值

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