Spring Boot 生鲜电商项目接口文档
用户模块
注册新用户
请求地址 | /register |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
userName | 用户名 | xiaomu | |
password | 密码 | 12345678 |
请求示例
/register?userName=xiaomu&password=12345678
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
登录
请求地址 | /login |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
userName | 用户名 | xiaomu | |
password | 密码 | 12345678 |
请求示例
/login?userName=xiaomu&password=12345678
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"id": 9,
"username": "xiaomu2",
"password": null,
"personalizedSignature": "祝你今天好心情",
"role": 2,
"createTime": "2020-02-09T12:39:47.000+0000",
"updateTime": "2020-02-10T16:56:02.000+0000"
}
}
更新个性签名
请求地址 | /user/update |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
signature | 更新的签名内容 | 更新了我的签名 |
请求示例
/user/update?signature=更新了我的签名
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
退出登录
请求地址 | /user/logout |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
无 |
请求示例
/user/logout
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
管理员登录
请求地址 | /adminLogin |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
userName | 用户名 | xiaomu | |
password | 密码 | 12345678 |
请求示例
/adminLogin?userName=xiaomu&password=12345678
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"id": 9,
"username": "xiaomu2",
"password": null,
"personalizedSignature": "祝你今天好心情",
"role": 2,
"createTime": "2020-02-09T12:39:47.000+0000",
"updateTime": "2020-02-10T16:56:02.000+0000"
}
}
商品分类模块
后台管理:
增加目录分类
请求地址 | /admin/category/add |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
name | 目录名 | 新鲜水果 | |
type | 目录层级 | 1 | 不超过3级 |
parentId | 父目录的ID | 2 | 1级目录的parentId为0 |
orderNum | 排序 | 5 | 同级目录的排序 |
请求示例
/admin/category/add
body:
{"name":"食品","type":1,"parentId":0,"orderNum":1}
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
更新目录分类
请求地址 | /admin/category/update |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
id | 目录的id | 4 | |
name | 目录名 | 新鲜水果 | |
type | 目录层级 | 1 | 不超过3级 |
parentId | 父目录的ID | 2 | 1级目录的parentId为0 |
orderNum | 排序 | 5 | 同级目录的排序 |
请求示例
/admin/category/update
body:
{"id":"1","name":"食品品品品","type":1,"parentId":0,"orderNum":1}
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
删除分类
请求地址 | /admin/category/delete |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
id | 目录的id | 4 |
请求示例
/admin/category/delete?id=1
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
分类列表(平铺)
请求地址 | /admin/category/list?pageNum=1&pageSize=10 |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
pageNum | 页数 | 1 | |
pageSize | 每页条数 | 10 |
请求示例
/admin/category/list?pageNum=1&pageSize=10
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"total": 19,
"list": [
{
"id": 3,
"name": "新鲜水果",
"type": 1,
"parentId": 0,
"orderNum": 1,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T09:11:26.000+0000"
},
{
"id": 5,
"name": "海鲜水产",
"type": 1,
"parentId": 0,
"orderNum": 2,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:20.000+0000"
},
{
"id": 6,
"name": "精选肉类",
"type": 1,
"parentId": 0,
"orderNum": 3,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:21.000+0000"
},
{
"id": 9,
"name": "冷饮冻食",
"type": 1,
"parentId": 0,
"orderNum": 4,
"createTime": "2019-12-20T05:45:28.000+0000",
"updateTime": "2019-12-28T08:25:22.000+0000"
},
{
"id": 10,
"name": "蔬菜蛋品",
"type": 1,
"parentId": 0,
"orderNum": 5,
"createTime": "2019-12-20T05:45:28.000+0000",
"updateTime": "2019-12-28T08:25:23.000+0000"
},
{
"id": 27,
"name": "美味菌菇",
"type": 1,
"parentId": 0,
"orderNum": 7,
"createTime": "2019-12-20T05:45:28.000+0000",
"updateTime": "2020-02-10T15:20:36.000+0000"
},
{
"id": 4,
"name": "橘子橙子",
"type": 2,
"parentId": 3,
"orderNum": 1,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:10.000+0000"
},
{
"id": 7,
"name": "螃蟹",
"type": 2,
"parentId": 5,
"orderNum": 1,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:15.000+0000"
},
{
"id": 17,
"name": "冰淇淋",
"type": 2,
"parentId": 9,
"orderNum": 1,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:18.000+0000"
},
{
"id": 16,
"name": "牛羊肉",
"type": 2,
"parentId": 6,
"orderNum": 1,
"createTime": "2019-12-17T17:17:00.000+0000",
"updateTime": "2019-12-28T08:25:18.000+0000"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 10,
"startRow": 1,
"endRow": 10,
"pages": 2,
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [
1,
2
],
"navigateFirstPage": 1,
"navigateLastPage": 2
}
}
前台:
分类列表(递归)
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
无 |
请求示例
/category/list
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": [
{
"id": 3,
"name": "新鲜水果",
"type": 1,
"parentId": 0,
"orderNum": 1,
"childCategory": [
{
"id": 4,
"name": "橘子橙子",
"type": 2,
"parentId": 3,
"orderNum": 1,
"childCategory": [
{
"id": 19,
"name": "果冻橙",
"type": 3,
"parentId": 4,
"orderNum": 1,
"childCategory": []
}
]
},
{
"id": 11,
"name": "草莓",
"type": 2,
"parentId": 3,
"orderNum": 2,
"childCategory": []
},
{
"id": 12,
"name": "奇异果",
"type": 2,
"parentId": 3,
"orderNum": 3,
"childCategory": []
},
{
"id": 14,
"name": "车厘子",
"type": 2,
"parentId": 3,
"orderNum": 4,
"childCategory": []
},
{
"id": 28,
"name": "其他水果",
"type": 2,
"parentId": 3,
"orderNum": 4,
"childCategory": []
}
]
},
{
"id": 5,
"name": "海鲜水产",
"type": 1,
"parentId": 0,
"orderNum": 2,
"childCategory": [
{
"id": 7,
"name": "螃蟹",
"type": 2,
"parentId": 5,
"orderNum": 1,
"childCategory": []
},
{
"id": 8,
"name": "鱼类",
"type": 2,
"parentId": 5,
"orderNum": 2,
"childCategory": []
},
{
"id": 13,
"name": "海参",
"type": 2,
"parentId": 5,
"orderNum": 3,
"childCategory": []
}
]
},
{
"id": 6,
"name": "精选肉类",
"type": 1,
"parentId": 0,
"orderNum": 3,
"childCategory": [
{
"id": 16,
"name": "牛羊肉",
"type": 2,
"parentId": 6,
"orderNum": 1,
"childCategory": []
}
]
},
{
"id": 9,
"name": "冷饮冻食",
"type": 1,
"parentId": 0,
"orderNum": 4,
"childCategory": [
{
"id": 17,
"name": "冰淇淋",
"type": 2,
"parentId": 9,
"orderNum": 1,
"childCategory": []
}
]
},
{
"id": 10,
"name": "蔬菜蛋品",
"type": 1,
"parentId": 0,
"orderNum": 5,
"childCategory": [
{
"id": 18,
"name": "蔬菜综合",
"type": 2,
"parentId": 10,
"orderNum": 1,
"childCategory": []
}
]
},
{
"id": 27,
"name": "美味菌菇",
"type": 1,
"parentId": 0,
"orderNum": 7,
"childCategory": [
{
"id": 15,
"name": "火锅食材",
"type": 2,
"parentId": 27,
"orderNum": 5,
"childCategory": []
}
]
}
]
}
商品模块
后台管理:
增加商品
请求地址 | /admin/product/add |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
name | 商品名称 | 猕猴桃 | |
categoryId | 目录ID | 5 | |
price | 价格 | 1000 | 单位是分 |
stock | 库存 | 10 | |
detail | 商品描述 | 新西兰黄心,黄金奇异果 | |
image | 商品图片 | http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png |
请求示例
/admin/product/add
body:
{"name":"猕猴桃","categoryId":5,"price":1000,"stock":10,"status":1,"detail":"新西兰黄心,黄金奇异果","image":"http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png"}
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
上传图片
请求地址 | /admin/upload/file |
---|---|
请求方式 | POST |
参数:
body 的类型是 form-data,key 是 file,value 是里传 file 类型的文件:
返回:
{
"status": 10000,
"msg": "SUCCESS",
"data": "http://127.0.0.1:8082/upload/b899f512-3467-4c71-8d2d-2d491b21f429.png"
}
更新商品
请求地址 | /admin/product/update |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
id | 商品ID | 1 | |
name | 商品名称 | 猕猴桃 | |
categoryId | 目录ID | 5 | |
price | 价格 | 1000 | 单位是分 |
stock | 库存 | 10 | |
detail | 商品描述 | 新西兰黄心,黄金奇异果 | |
image | 商品图片 | http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png |
请求示例
/admin/product/add
body:
{"id":3,"name":"早餐小面包 3","categoryId":5,"price":1000,"stock":10,"status":1,"detail":"好吃的小面包","image":"http://127.0.0.1:8083/images/6037baf8-5251-4560-be5a-32b8ee3823cf.png"}
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
删除商品
请求地址 | /admin/product/delete |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
id | 商品的id | 1 |
请求示例
/admin/product/delete?id=1
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
批量上下架商品
请求地址 | /admin/product/delete |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
ids | 要更改的商品的id | 1,2,4 | 数组 |
sellStatus | 上下架状态 | 1 | 1是上架,0是下架 |
请求示例
/admin/product/batchUpdateSellStatus?ids=1,2,4&sellStatus=1
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
商品列表(后台)
请求地址 | /admin/product/list |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
pageNum | 页数 | 1 | 默认会按照修改时间倒序 |
pageSize | 每页条数 | 10 |
请求示例
/admin/product/list?pageSize=5&pageNum=1
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"total": 20,
"list": [
{
"id": 40,
"name": "胡萝卜",
"image": "http://127.0.0.1:8083/images/huluobo.jpg",
"detail": "商品名称:绿鲜知胡萝卜商品编号:4116192商品毛重:1.07kg商品产地:北京包装:简装分类:萝卜烹饪建议:火锅,炒菜,炖菜",
"categoryId": 18,
"price": 222,
"stock": 222,
"status": 1,
"createTime": "2019-12-28T08:06:34.000+0000",
"updateTime": "2020-02-10T16:53:25.000+0000"
}
],
"pageNum": 1,
"pageSize": 1,
"size": 1,
"startRow": 1,
"endRow": 1,
"pages": 20,
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [
1,
2,
3,
4,
5,
6,
7,
8
],
"navigateFirstPage": 1,
"navigateLastPage": 8
}
}
前台:
商品列表
请求地址 | /product/list |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderBy | 排序方式 | price desc | price desc 或者 price asc |
categoryId | 商品分类 Id | 1 | |
keyword | 搜索的关键词 | 桃 | |
pageNum | 页数 | 1 | |
pageSize | 每页条数 | 10 |
请求示例
/product/list?orderBy=price desc&categoryId=4
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"total": 20,
"list": [
{
"id": 2,
"name": "澳洲进口大黑车厘子大樱桃包甜黑樱桃大果多汁 500g 特大果",
"image": "http://127.0.0.1:8083/images/chelizi2.jpg",
"detail": "商品毛重:1.0kg货号:608323093445原产地:智利类别:美早热卖时间:1月,11月,12月国产/进口:进口售卖方式:单品",
"categoryId": 14,
"price": 50,
"stock": 100,
"status": 1,
"createTime": "2019-12-18T08:08:15.000+0000",
"updateTime": "2020-02-10T16:08:25.000+0000"
},
{
"id": 3,
"name": "茶树菇 美味菌菇 东北山珍 500g",
"image": "http://127.0.0.1:8083/images/chashugu.jpg",
"detail": "商品名:茶树菇 商品特点:美味菌菇 东北山珍 500g",
"categoryId": 15,
"price": 1000,
"stock": 6,
"status": 1,
"createTime": "2019-12-18T08:10:50.000+0000",
"updateTime": "2020-02-10T16:42:42.000+0000"
},
{
"id": 14,
"name": "Zespri佳沛 新西兰阳光金奇异果 6个装",
"image": "http://127.0.0.1:8083/images/mihoutao2.jpg",
"detail": "商品编号:4635056商品毛重:0.71kg商品产地:新西兰类别:金果包装:简装国产/进口:进口原产地:新西兰",
"categoryId": 12,
"price": 39,
"stock": 77,
"status": 1,
"createTime": "2019-12-18T08:11:13.000+0000",
"updateTime": "2020-02-10T15:36:48.000+0000"
},
{
"id": 17,
"name": "红颜奶油草莓 约重500g/20-24颗 新鲜水果",
"image": "http://127.0.0.1:8083/images/caomei2.jpg",
"detail": "商品毛重:0.58kg商品产地:丹东/南通/武汉类别:红颜草莓包装:简装国产/进口:国产",
"categoryId": 11,
"price": 99,
"stock": 84,
"status": 1,
"createTime": "2019-12-18T08:11:13.000+0000",
"updateTime": "2020-02-10T15:37:48.000+0000"
},
{
"id": 21,
"name": "智利原味三文鱼排(大西洋鲑)240g/袋 4片装",
"image": "http://127.0.0.1:8083/images/sanwenyu2.jpg",
"detail": "商品毛重:260.00g商品产地:中国大陆保存状态:冷冻国产/进口:进口包装:简装类别:三文鱼海水/淡水:海水烹饪建议:煎炸,蒸菜,烧烤原产地:智利",
"categoryId": 8,
"price": 499,
"stock": 1,
"status": 1,
"createTime": "2019-12-28T07:13:07.000+0000",
"updateTime": "2020-02-10T15:38:46.000+0000"
},
{
"id": 22,
"name": "即食海参大连野生辽刺参 新鲜速食 特级生鲜海产 60~80G",
"image": "http://127.0.0.1:8083/images/haishen.jpg",
"detail": "商品毛重:1.5kg商品产地:中国大陆贮存条件:冷冻重量:50-99g国产/进口:国产适用场景:养生滋补包装:袋装原产地:辽宁年限:9年以上等级:特级食品工艺:冷冻水产热卖时间:9月类别:即食海参固形物含量:70%-90%特产品类:大连海参售卖方式:单品",
"categoryId": 13,
"price": 699,
"stock": 3,
"status": 1,
"createTime": "2019-12-28T07:16:29.000+0000",
"updateTime": "2020-02-10T16:04:29.000+0000"
},
{
"id": 23,
"name": "澳大利亚直采鲜橙 精品澳橙12粒 单果130-180g",
"image": "http://127.0.0.1:8083/images/chengzi.jpg",
"detail": "商品毛重:2.27kg商品产地:澳大利亚类别:脐橙包装:简装国产/进口:进口原产地:澳大利亚",
"categoryId": 4,
"price": 12,
"stock": 12,
"status": 1,
"createTime": "2019-12-28T08:02:13.000+0000",
"updateTime": "2020-02-10T16:40:15.000+0000"
},
{
"id": 24,
"name": "智利帝王蟹礼盒装4.4-4.0斤/只 生鲜活鲜熟冻大螃蟹",
"image": "http://127.0.0.1:8083/images/diwangxie.jpg",
"detail": "商品毛重:3.0kg商品产地:智利大闸蟹售卖方式:公蟹重量:2000-4999g套餐份量:5人份以上国产/进口:进口海水/淡水:海水烹饪建议:火锅,炒菜,烧烤,刺身,加热即食包装:简装原产地:智利保存状态:冷冻公单蟹重:5.5两及以上分类:帝王蟹特产品类:其它售卖方式:单品",
"categoryId": 7,
"price": 222,
"stock": 222,
"status": 1,
"createTime": "2019-12-28T08:06:34.000+0000",
"updateTime": "2020-02-10T16:05:05.000+0000"
},
{
"id": 25,
"name": "新疆库尔勒克伦生无籽红提 国产新鲜红提葡萄 提子 5斤装",
"image": "http://127.0.0.1:8083/images/hongti.jpg",
"detail": "商品毛重:2.5kg商品产地:中国大陆货号:XZL201909002重量:2000-3999g套餐份量:2人份国产/进口:国产是否有机:非有机单箱规格:3个装,4个装,5个装类别:红提包装:简装原产地:中国大陆售卖方式:单品",
"categoryId": 28,
"price": 222,
"stock": 222,
"status": 1,
"createTime": "2019-12-28T08:06:34.000+0000",
"updateTime": "2020-02-10T16:44:05.000+0000"
},
{
"id": 26,
"name": "越南进口红心火龙果 4个装 红肉中果 单果约330-420g",
"image": "http://127.0.0.1:8083/images/hongxinhuolongguo.jpg",
"detail": "商品毛重:1.79kg商品产地:越南重量:1000-1999g类别:红心火龙果包装:简装国产/进口:进口",
"categoryId": 28,
"price": 222,
"stock": 222,
"status": 1,
"createTime": "2019-12-28T08:06:34.000+0000",
"updateTime": "2020-02-10T16:44:11.000+0000"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 10,
"startRow": 1,
"endRow": 10,
"pages": 2,
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [
1,
2
],
"navigateFirstPage": 1,
"navigateLastPage": 2
}
}
商品详情
请求地址 | /product/detail |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
id | 商品ID | 2 |
请求示例
/product/detail?id=2
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"id": 2,
"name": "澳洲进口大黑车厘子大樱桃包甜黑樱桃大果多汁 500g 特大果",
"image": "http://127.0.0.1:8083/images/chelizi2.jpg",
"detail": "商品毛重:1.0kg货号:608323093445原产地:智利类别:美早热卖时间:1月,11月,12月国产/进口:进口售卖方式:单品",
"categoryId": 14,
"price": 50,
"stock": 100,
"status": 1,
"createTime": "2019-12-18T08:08:15.000+0000",
"updateTime": "2020-02-10T16:08:25.000+0000"
}
}
购物车模块(都是前台的)
1 购物车列表
请求地址 | /cart/list |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
无 |
请求示例
/cart/list
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": [
{
"id": 5,
"productId": 3,
"userId": 9,
"quantity": 1,
"selected": 1,
"price": 1000,
"totalPrice": 1000,
"productName": "茶树菇 美味菌菇 东北山珍 500g",
"productImage": "http://127.0.0.1:8083/images/chashugu.jpg"
}
]
}
2 添加商品到购物车
请求地址 | /cart/add |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
productId | 商品ID | 5 | |
count | 数量 | 1 |
请求示例
/cart/add?productId=5&count=1
返回的是“购物车列表”
3 更新购物车某个商品的数量
请求地址 | /cart/update |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
productId | 商品ID | 5 | |
count | 数量 | 1 |
请求示例
/cart/update?productId=5&count=1
返回的是“购物车列表”
4 删除购物车的某个商品
请求地址 | /cart/delete |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
productId | 商品ID | 5 |
请求示例
/cart/delete?productId=5
返回的是“购物车列表”
5 选中/不选中购物车的某个商品
请求地址 | /cart/select |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
productId | 商品ID | 5 | |
selected | 是否选中 | 1 | 0 是不选中,1 是选中 |
请求示例
/cart/select?productId=2&selected=1
返回的是“购物车列表”
6 全选/全不选购物车的某个商品
请求地址 | /cart/selectAll |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
selected | 是否选中 | 1 | 0 是不选中,1 是选中 |
请求示例
/cart/selectAll?selected=1
返回的是“购物车列表”
订单模块
前台显示
前台:创建订单
请求地址 | /order/create |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
receiverName | 收件人姓名 | 小慕 | |
receiverMobile | 收件人电话 | 18888888888 | |
receiverAddress | 收件人地址 | 中国慕城 |
请求示例
/order/create
body:
{"receiverName":"小慕","receiverMobile":"18888888888","receiverAddress":"中国慕城"}
这三个参数都是必传
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": orderNo
}
前台:订单详情
请求地址 | /order/detail |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/order/detail?orderNo=101442166222
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"orderNo": "116214445684",
"userId": 9,
"totalPrice": 1000,
"receiverName": "小慕",
"receiverMobile": "18888888888",
"receiverAddress": "中国慕城",
"orderStatus": 10,
"postage": 0,
"paymentType": 1,
"deliveryTime": null,
"payTime": null,
"endTime": null,
"createTime": "2020-02-11T08:21:44.000+0000",
"orderItemVOList": [
{
"orderNo": "116214445684",
"productName": "茶树菇 美味菌菇 东北山珍 500g",
"productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
"unitPrice": 1000,
"quantity": 1,
"totalPrice": 1000
}
],
"orderStatusName": "未付款(初始状态)"
}
}
前台:订单列表
请求地址 | /order/list |
---|---|
请求方式 | GET |
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
pageNum | 页数 | 1 | |
pageSize | 每页条数 | 10 |
请求示例
/order/list?pageNum=1&pageSize=10
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"total": 1,
"list": [
{
"orderNo": "116214445684",
"userId": 9,
"totalPrice": 1000,
"receiverName": "小慕",
"receiverMobile": "18888888888",
"receiverAddress": "中国慕城",
"orderStatus": 10,
"postage": 0,
"paymentType": 1,
"deliveryTime": null,
"payTime": null,
"endTime": null,
"createTime": "2020-02-11T08:21:44.000+0000",
"orderItemList": [
{
"orderNo": "116214445684",
"productName": "茶树菇 美味菌菇 东北山珍 500g",
"productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
"unitPrice": 1000,
"quantity": 1,
"totalPrice": 1000
}
],
"orderStatusName": "未付款(初始状态)"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 1,
"endRow": 1,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
前台:取消订单
请求地址 | /order/cancel |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/order/cancel?orderNo=101442166222
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
生成支付二维码
在支付的时候显示的二维码
请求地址 | /order/qrcode |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/order/cancel?orderNo=101442166222
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": "127.0.0.1:8082/images/101442166222.png"
}
前台:支付订单
请求地址 | /pay |
---|---|
请求方式 | GET |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/pay?orderNo=101442166222
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
后台管理
后台:订单列表
请求地址 | /admin/order/list |
---|---|
请求方式 | GET |
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
pageNum | 页数 | 1 | |
pageSize | 每页条数 | 10 |
请求示例
/admin/order/list?pageNum=1&pageSize=10
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": {
"total": 1,
"list": [
{
"orderNo": "116214445684",
"userId": 9,
"totalPrice": 1000,
"receiverName": "小慕",
"receiverMobile": "18888888888",
"receiverAddress": "中国慕城",
"orderStatus": 10,
"postage": 0,
"paymentType": 1,
"deliveryTime": null,
"payTime": null,
"endTime": null,
"createTime": "2020-02-11T08:21:44.000+0000",
"orderItemList": [
{
"orderNo": "116214445684",
"productName": "茶树菇 美味菌菇 东北山珍 500g",
"productImg": "http://127.0.0.1:8083/images/chashugu.jpg",
"unitPrice": 1000,
"quantity": 1,
"totalPrice": 1000
}
],
"orderStatusName": "未付款(初始状态)"
}
],
"pageNum": 1,
"pageSize": 1,
"size": 1,
"startRow": 0,
"endRow": 0,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
后台:订单发货
请求地址 | /admin/order/delivered |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/admin/order/delivered?orderNo=118213761282
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}
前后台通用
订单完结
请求地址 | /order/finish |
---|---|
请求方式 | POST |
参数
参数 | 参数含义 | 示例 | 备注 |
---|---|---|---|
orderNo | 订单号 | 101442166222 |
请求示例
/order/finish?orderNo=118213761282
返回示例
{
"status": 10000,
"msg": "SUCCESS",
"data": null
}