线上超市接口说明文档--NEW

1、用户模块

1.1用户登录验证接口

• 请求路径：/user/login
• 请求方式：post
• 请求参数：

参数名称	参数类型	参数说明	备注
userName	String	用户名	不能为null
userPassword	String	登录密码	不能为null

• 响应参数

参数名称	参数说明	备注
state	服务调用的状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回登录的user对象信息

• 返回格式展示：

{"status":200,"data":user对象信息}

1.2用户注册

• 请求路径：/user/register
• 请求方式：post
• 请求参数：

参数名称	参数类型	参数说明	备注
userName	String	用户名	不能为null
userPassword	String	登录密码	不能为null
userRole	Integer	用户角色	不能为null

• 服务响应格式展示：

{"status":200,"data":null}

1.3 获取用户列表信息

• 请求路径: /user/getUserList
• 请求类型: GET
• 请求参数: 后台使用PageResult对象接收

参数名称	参数类型	参数说明	备注
userName	String	用户名	可以为null
userState	Integer	用户状态	可以为null
userRole	Integer	用户角色	可以为null
pageNumber	Integer	当前页	不能为null
pageSize	Integer	每页显示的条数	不能为null

• 响应参数：SysResult对象 需要携带分页对象 PageResult

参数名称	参数说明	备注信息
status	状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回值PageResult对象

• PageResult对象简介：

参数名称	参数类型	参数说明	备注
userName	String	用户名	可以为null
userState	Integer	用户状态	可以为null
userRole	Integer	用户角色	可以为null
pageNumber	Integer	当前页	不能为null
pageSize	Integer	每页显示的条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

1.4 修改用户状态信息

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

参数名称	参数类型	参数说明	备注
userId	Integer	用户编号	不能为null
userState	Integer	用户状态信息	不能为null

• 返回值结果: SysResult对象：

{"status":200,"data":null}

1.5 查看用户（商家）注册申请清单

1.5.1 获取用户（商家）注册列表

• 请求路径 /user/getUserInfoByRole
• 请求类型 GET
• 请求参数:

参数名称	参数类型	参数说明	备注
userState	Integer	用户状态	固定值：3（表示为商家）
userRole	Integer	用户角色	固定值：0（表示待审核）
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null

• 响应参数：SysResult对象 需要携带分页对象 PageResult

参数名称	参数说明	备注信息
status	状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回值PageResult对象

• ***PageResult对象简介：详见1.3 ***

1.5.2 修改用户（商家）状态为可用（申请注册通过）

• 实现 详见1.4

1.6 添加用户（管理员、商家）信息

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

参数名称	参数类型	参数说明	备注
userName	String	用户名	不能为null
userPassword	String	用户密码	不能为null
userSex	Integer	用户性别	不能为null
userPhoneNumber	String	用户联系电话	不能为null
userRole	Integer	用户角色	不能为null
userState	Integer	用户状态	不能为null

• 服务响应格式展示：

{"status":200,"data":null}

1.7 完善个人信息

• 请求路径: /user/updateUser
• 请求类型: PUT
• 请求参数：User对象结构数据

参数名称	参数类型	参数说明	备注
userName	String	用户名	不能为null
userPersonName	String	用户姓名	可以为null
userSex	Integer	用户性别	不能为null
userPhoneNumber	String	用户联系电话	可以为null
userAddr	String	用户地址	可以为null
userBrithday	Date	用户出生年月	可以为null
userEmail	String	用户邮箱	可以为null
userPhoto	String	用户头像	可以为null
userRole	Integer	用户角色	不能为null
userState	Integer	用户状态	不能为null

• 响应结果：

{"status":200,"data":null}

2、商品模块

2.1、获取商品信息

• 请求路径: /goods/getGoodsList
• 请求类型: GET
• 请求参数: 后台使用GoodsPageResult对象接收

参数名称	参数类型	参数说明	备注
goodsName	String	商品名称	不能为null
goodsClasses	Integer	商品类别	可以为null
goodsState	Integer	商品状态	可以为null
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null

• 响应参数：SysResult对象 需要携带分页对象 PageResult

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回值GoodsPageResult对象

• GoodsPageResult对象简介:

参数名称	参数类型	参数说明	备注
goodsName	String	商品名称	不能为null
goodsClasses	Integer	商品类别	可以为null
goodsState	Integer	商品状态	可以为null
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

2.2 修改商品状态信息

• 请求路径 /goods/status/{id}/{status}
• 请求类型 PUT
• 请求参数: 商品ID/状态值数据
• 返回值结果: SysResult对象：

{"status":200,"data":null}

2.3 添加商品信息

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

参数名称	参数类型	参数说明	备注
goodsName	String	商品名称	不能为null
goodsPrice	Double	商品价格	不能为null
goodsDiscount	Double	商品折扣价	可以为null
goodsState	Integer	商品状态	不能为null
goodsAmount	Integer	商品库存量	不能为null
goodsIsNew	Integer	商品是否是新品	可以为null
goodsIsHot	Integer	商品是否是热卖	可以为null
goodsClassesId	Integer	商品分类编号（查询分类表示信息并以下拉列表的形式展现）	不能为null
goodsDetails	String	商品详情	可以为null
goodsPhoto	file	商品图片	可以为null

• 返回值结果: SysResult对象：

{"status":200,"data":null}

2.4 完善商品信息

• 请求路径: /goods/updateGoods
• 请求类型: PUT
• 请求参数：Goods对象结构数据（详见2.3请求参数）
• 响应参数

{"status":200,"data":null}

2.5 商品分类清单

2.5.1 商品分类清单信息查询

• 请求路径: /classes/getGoodsClassesList
• 请求类型: GET
• 请求参数: 后台使用GoodsClassesPageResult对象接收

参数名称	参数类型	参数说明	备注
classesName	String	类别名称	可以为null
classesLevel	Integer	类别级别	可以为null

• 响应参数：SysResult对象 需要携带分页对象 GoodsClassesPageResult

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回值GoodsClassesPageResult对象

• GoodsClassesPageResult对象简介:

参数名称	参数类型	参数说明	备注
classesName	String	类别名称	可以为null
classesLevel	Integer	类别级别	可以为null
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null
children	List	类别的孩子节点信息	可以为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

2.5.2 商品分类清单信息修改

• 请求路径 /classes/updateClasses
• 请求类型 PUT
• 请求参数: 商品分类清单信息对象信息

参数名称	参数类型	参数说明	备注
classesID	Integer	修改的类别编号信息	不能为null
classesName	String	类别名称	不能为null
classesLevel	Integer	类别级别	不能为null
classesParentId	Integer	类别父节点信息	不能为null

• 响应信息：

{"status":200,"data":null}

2.5.3 商品分类清单信息删除

• 请求路径 /classes/deleteClassesById/{id}
• 请求类型 PUT
• 请求参数: 商品分类清单ID
• 返回值结果: SysResult对象：

{"status":200,"data":null}

2.5.4 商品分类清单信息增加

• 请求路径 /classes/addClasses
• 请求类型 POST
• 请求参数: 商品分类清单信息对象信息

参数名称	参数类型	参数说明	备注
classesName	String	类别名称	不能为null
classesLevel	Integer	类别级别	不能为null
classesParentId	Integer	类别父节点信息	不能为null

• 响应信息：

{"status":200,"data":null}

3、订单模块

3.1 订单信息列表获取

• 请求路径: /order/getOrderList
• 请求类型: GET
• 请求参数: 后台使用OrderPageResult对象接收

参数名称	参数类型	参数说明	备注
orderId	String	订单编号	可以为null
userId	Integer	用户编号	可以为null
orderState	Integer	订单状态	可以为null
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null

• 响应参数：SysResult对象 需要携带分页对象 OrderPageResult

参数名称	参数说明	备注
status	状态信息	200表示服务器请求成功 201表示服务器异常
data	服务器返回的业务数据	返回值OrderPageResult对象

• OrderPageResult对象简介:

参数名称	参数类型	参数说明	备注
orderId	String	订单编号	可以为null
userId	Integer	用户编号	可以为null
orderState	Integer	订单状态	可以为null
pageNumber	Integer	当前查询页	不能为null
pageSize	Integer	每页显示的条数	不能为null
total	Long	查询总记录数	不能为null
rows	Object	分页查询的结果	不能为null

3.2 修改订单状态信息

• 请求路径 /order/status/{id}/{status}
• 请求类型 PUT
• 请求参数: 订单ID/状态值数据
• 返回值结果: SysResult对象：

{"status":200,"data":null}

3.3 修改订单信息

• 请求路径 /order/updateOrder
• 请求类型 PUT
• 请求参数: 订单对象信息

参数名称	参数类型	参数说明	备注
orderId	String	订单编号	不能为null
userName	String	收件人	不能为null
userPhoneNumber	String	收件人联系电话	不能为null
userAddr	String	收件人地址	不能为null
orderState	Integer	订单状态	不能为null

• 响应信息：

{"status":200,"data":null}

3.4 删除订单信息

• 请求路径 /order/deleteOrder/{id}
• 请求类型 PUT
• 请求参数: 订单ID
• 返回值结果: SysResult对象：

{"status":200,"data":null}

3.5 查看订单详情

• 请求路径 /order/getOrderDetail/{orderId}
• 请求类型 GET
• 请求参数: 订单ID
• 响应对象：订单对应的订单详情对象

参数名称	参数类型	参数说明	备注
orderId	String	订单编号	不能为null
goodsId	Integer	商品编号	不能为null
goodsName	String	商品名称	不能为null
goodsConst	Double	商品成交价	不能为null
goodsCount	Integer	商品成交数量	不能为null