京淘项目业务接口文档

最新推荐文章于 2024-03-26 19:28:29 发布

Limit@AI

最新推荐文章于 2024-03-26 19:28:29 发布

阅读量237

点赞数

原文链接：https://blog.csdn.net/qq_16804847/article/details/116671831

版权

1.用户登陆

1.1 用户登录验证接口

请求路径: /user/login
请求方式: POST
请求参数

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

响应数据 SysResult对象

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

返回值格式如下:


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

2.页面布局

2.1 左侧菜单获取

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

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

响应数据如图所示

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	服务器返回的业务数据	返回值PageResult对象

PageResult 对象介绍

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

返回值效果

{"status":200,
  "msg":"服务器调用成功!",
  "data":
	{"query":"",
	"pageNum":1,
	"pageSize":2,
	"total":4,
	"rows":[
		{"created":"2021-02-18T11:17:23.000+00:00",
		 "updated":"2021-03-26T06:47:20.000+00:00",
		 "id":1,
		 "username":"admin",
		 "password":"a66abb5684c45962d887564f08346e8d",
		 "phone":"13111112222",
		 "email":"1235678@qq.com",
		 "status":true,
		 "role":null
		 },
		{"created":"2021-02-18T11:17:23.000+00:00",
		"updated":"2021-03-13T08:50:30.000+00:00",
		"id":2,
		"username":"admin123",
		"password":"a66abb5684c45962d887564f08346e8d",
		"phone":"13111112223",
		"email":"1235678@qq.com",
		"status":false,
		"role":null
		}
		]
	}
}

4.用户状态修改

请求路径 /user/status/{id}/{status}
请求类型 PUT
请求参数: 用户ID/状态值数据

参数名称	参数类型	参数说明	备注信息
id	Integer	用户ID号	不能为null
status	boolean	参数状态信息	不能为null

返回值结果: SysResult对象

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

 
 
 
 1

6. 用户新增

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

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

返回值结果: SysResult对象

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

 
 
 
 1

6. 用户修改

6.1 根据ID查询用户信息

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

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

JSON格式如下:

{
 "status":200,
 "msg":"服务器调用成功!",
 "data":{
	 "created":"2021-02-18T11:17:23.000+00:00",
	 "updated":"2021-05-17T11:33:46.000+00:00",
	 "id":1,
	 "username":"admin",
	 "password":"a66abb5684c45962d887564f08346e8d",
	 "phone":"13111112222",
	 "email":"1235678@qq.com",
	 "status":true,
	 "role":null
	 }
 }

6.2 根据用户ID更新数据

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

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

返回值: SysResult对象

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

JSON格式如下:

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

 
 
 
 1
2
3
4
5

6.3 根据ID删除用户

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

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

返回值: SysResult对象

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

7. 商品分类实现

7.1 查询3级商品分类信息

请求路径: /itemCat/findItemCatList
请求类型: get
请求参数: type

参数名称	参数说明	备注
type	查询级别	1查询一级分类 2查询二级商品分类 3查询3级商品分类

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

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

7.2 修改商品分类状态

请求路径: /itemCat/status/{id}/{status}
请求类型: put
请求参数:

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

返回值: SysResult对象

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

7.3 商品分类新增

请求路径: /itemCat/saveItemCat
请求类型: post
请求参数: 表单数据

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

返回值: SysResult对象

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

7.4 商品分类修改

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

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

7.5 商品分类删除

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

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

返回值结果 SysResult对象

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

8 商品分类参数实现

8.1 获取商品分类参数列表

请求路径: /itemCatParam/findItemCatParamListByType?itemCatId=564&paramType=1
请求类型: get
业务描述: 根据商品分类和参数类型,查询信息
请求参数:

参数名称	参数说明	备注
itemCatId	商品分类ID号	不能为null
paramType	商品分类参数的类型	不能为null 1 为动态类型 2为静态属性

返回值结果:

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

{"status":200,
  "msg":"服务器调用成功!",
  "data":
  	[
  	  {
  	  "created":"2021-04-13T15:45:01.000+00:00",
  	  "updated":"2021-04-19T03:00:09.000+00:00",
  	  "paramId":1,
  	  "paramName":"选择颜色",
  	  "itemCatId":560,
  	  "paramType":1,
  	  "paramVals":"亮黑色,釉白色,秘银色,夏日胡杨,秋日胡杨,白色,黑色"
  	  },
  	  {
  	  	"created":"2021-04-13T15:45:01.000+00:00",
  	  	"updated":"2021-04-13T15:45:01.000+00:00",
  	  	"paramId":2,
  	  	"paramName":"选择版式",
  	  	"itemCatId":560,
  	  	"paramType":1,
  	  	"paramVals":"8GB+128GB,8GB+256GB,8GB+512GB"
  	  	}
	  ]
  	}

8.2 商品分类参数新增

请求路径: /itemCatParam/addItemCatParam
请求类型: post
业务描述: 实现商品分类参数新增操作
请求参数: 使用itemCatParam对象接收

参数名称	参数说明	备注
itemCatId	商品分类ID号	不能为null
paramName	商品分类参数名称	不能为null
paramType	商品分类参数类型	不能为null

返回值结果:

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

8.3 商品分类参数更新

请求路径: /itemCatParam/updateItemCatParam
请求类型: put
请求参数: 使用itemCatParam对象接收

参数名称	参数说明	备注
paramId	商品分类参数ID号	不能为null
paramName	商品分类参数名称	不能为null

返回值结果:

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

8.4 商品分类参数删除

请求路径: /itemCatParam/deleteItemCatParamById?paramId=20
请求类型: delete
请求参数:

参数名称	参数说明	备注
paramId	商品分类参数ID号	不能为null

返回值结果:

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

8.6 商品分类参数规格修改

请求路径: /itemCatParam/updateItemCatParam
请求类型: put
请求参数: 使用对象接收

参数名称	参数说明	备注
paramId	商品分类参数ID号	不能为null
paramVals	商品分类规格信息	多个参数使用,号分割

返回值结果:

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

9 商品模块实现

9.1 商品列表展现

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

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

返回值结果:

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

9.2 商品状态修改

请求路径: /item/updateItemStatus
请求类型: put
请求参数: 使用对象接收

参数名称	参数说明	备注
id	商品id	不能为null
status	状态信息	不能为null

返回值结果:

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

9.3 商品数据删除

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

参数名称	参数说明	备注
id	商品id	不能为null

返回值结果:

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