# SMall
**Repository Path**: GAATTC/SMall
## Basic Information
- **Project Name**: SMall
- **Description**: a small mall project
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-08-05
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 在线商城接口文档
## 一.后台管理系统
### 1.管理员账号模块
#### 0.初始化
##### (1)接口说明
获取所有管理员信息
##### (2)请求方式
GET
##### (3)Uri
/api/admin/admin/allAdmins
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"email": "admin",
"nickname": "test",
"pwd": "admin"
}, {
"id": 2,
"email": "416569605@qq.com",
"nickname": "gaattc",
"pwd": "Dwh1111?"
}, {
"id": 9,
"email": "135135@qq.com",
"nickname": "nickname",
"pwd": "Dwdw1153?"
}, {
"id": 15,
"email": "1351151384@qq.com",
"nickname": "asdsadas",
"pwd": "Dwndik3155?"
}, {
"id": 17,
"email": "41351351@qq.com",
"nickname": "adw153da",
"pwd": "Dada1351?!"
}, {
"id": 18,
"email": "13513225@qq.com",
"nickname": "nickname1",
"pwd": "Dwdw1153?1"
}]
}
```
#### 1.登录
##### (1)接口说明
登录后台管理系统
##### (2)请求方式
POST
##### (3)Uri
/api/admin/admin/login
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ------ |
| name | str | 必须 | 用户名 |
| pwd | str | 必须 | 密码 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 必须 | 返回状态码,0表示正常 |
| data | object | 必须 | 返回的数据 |
| message | str | 非必须 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"token": "admin",
"name": "admin"
}
}
```
#### 2.增
##### (1)接口说明
新增后台管理员
##### (2)请求方式
POST
##### (3)Uri
/api/admin/admin/addAdminss
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| :----- | -------- | -------- | ------ |
| email | str | 是 | 邮箱 |
| nickname | str | 是 | 昵称 |
| pwd | str | 是 | 密码 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 必须 | 返回状态码,0表示正常 |
| data | object | 非必须 | 返回的数据 |
| message | str | 非必须 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 3.删
##### (1)接口说明
删除管理员
##### (2)请求方式
GET
##### (3)Uri
/api/admin/admin/deleteAdmins
##### (4)请求参数
url参数
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ------ |
| id | int | 是 | 管理员id |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 必须 | 返回状态码,0表示正常 |
| data | object | 非必须 | 返回的数据 |
| message | str | 非必须 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 4.改查
##### (1)接口说明
更改管理员信息
##### (2)请求方式
POST
##### (3)Uri
/api/admin/admin/updateAdminss
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| -------- | -------- | -------- | ---- |
| email | str | 1 | 邮箱 |
| id | int | 1 | id |
| nickname | str | 1 | 昵称 |
| pwd | str | 1 | 密码 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 必须 | 返回状态码,0表示正常 |
| data | object | 非必须 | 返回的数据 |
| message | str | 非必须 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 5.多条件查询
##### (1)接口说明
多条件查询管理员
##### (2)请求方式
POST
##### (3)Uri
/api/admin/getSearchAdmins
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ----- | ------- | ------- | ---- |
| email | str | 1 | 邮箱 |
| nickname | str | 1 | 昵称 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"email": "admin",
"nickname": "admin",
"pwd": "admin"
}]
}
```
#### 6.修改密码
##### (1)接口说明
修改管理员密码
##### (2)请求方式
POST
##### (3)Uri
/api/admin/admin/
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| adminToken | str | 1 | 令牌 |
| confirmPwd | str | 1 | 确认密码 |
|newPwd |str|1| 新密码 |
|oldPwd |str|1| 旧密码 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
### 2.用户管理模块
#### 0.初始化
##### (1)接口说明
查询所有用户信息
##### (2)请求方式
GET
##### (3)Uri
/api/admin/user/allUser
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 用户数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"email": "123@qq.com",
"nickname": "gaattc",
"pwd": "Dwh1234?",
"recipient": "gaattc",
"address": "武汉",
"phone": "18551811111"
}]
}
```
#### 1.删除用户
##### (1)接口说明
删除用户
##### (2)请求方式
GET
##### (3)Uri
/api/admin/user/deleteUser
##### (4)请求参数
url参数
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | -------------- |
| id | int | 1 | 要删除的用户id |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 2.查找用户
##### (1)接口说明
查找用户
##### (2)请求方式
GET
##### (3)Uri
/api/admin/user/searchUser
##### (4)请求参数
url参数
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ------------------ |
| word | str | 1 | 用户昵称或其一部分 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"email": "123@qq.com",
"nickname": "gaattc",
"pwd": "Dwh1234?",
"recipient": "gaattc",
"address": "武汉",
"phone": "18551811111"
}]
}
```
### 3.商品管理模块
#### 0.获取商品类型
##### (1)接口说明
获取商品类型信息
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/getType
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"name": "女装"
}, {
"id": 2,
"name": "男装"
}, {
"id": 3,
"name": "电子产品"
}, {
"id": 5,
"name": "游戏"
}]
}
```
#### 1.通过类型获取商品信息
##### (1)接口说明
通过类型获取商品信息
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/getGoodsByType
##### (4)请求参数
url参数
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---------- |
| typeId | int | 1 | 商品类型id |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"img": "http://localhost:8084/static/image/qiezi.jpg",
"name": "茄子",
"price": 100,
"typeId": 1,
"stockNum": 100
}, {
"id": 2,
"img": "http://localhost:8084/static/image/liubo.jpg",
"name": "刘波",
"price": 200,
"typeId": 1,
"stockNum": 99
}]
}
```
#### 2.添加类目
##### (1)接口说明
添加商品类型
##### (2)请求方式
POST
##### (3)Uri
/api/admin/goods/addType
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---------- |
| name | str | 1 | 商品类型名 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 3.删除商品类型
##### (1)接口说明
删除商品类型和其中所有商品(谨慎)
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/deleteType
##### (4)请求参数
url参数
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---------- |
| typeId | int | 1 | 商品类型id |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 4.上传图片
##### (1)接口说明
上传图片至后端服务器
##### (2)请求方式
POST
##### (3)Uri
/api/admin/goods/imgUpload
##### (4)请求参数
binary
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": "http://localhost:8084/static/image/70ad3d60-c0bb-43b1-802b-acc0845af1ad-IMG_PITU_20200325_091153.jpg"
}
```
#### 5.添加商品
##### (1)接口说明
添加商品
##### (2)请求方式
POST
##### (3)Uri
/api/admin/user/deleteUser
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| -------- | -------- | -------- | -------- |
| name | str | 1 | 商品名 |
| typeId | int | 1 | 商品类id |
| img | str | 1 | 图片地址 |
| desc | str | 1 | 描述 |
| specList | object | 1 | 规格表 |
**示例:**
```json
{
"name": "name",
"typeId": "1",
"img": "http://localhost:8084/static/image/70ad3d60-c0bb-43b1-802b-acc0845af1ad-IMG_PITU_20200325_091153.jpg",
"desc": "desc",
"specList": [{
"specName": "默认",
"stockNum": "1",
"unitPrice": "1"
}, {
"specName": "45",
"stockNum": "34",
"unitPrice": "534"
}]
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code":0
}
```
#### 6.获取商品详细信息
##### (1)接口说明
编辑时获取商品详细信息
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/getGoodsInfo
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"specs": [{
"id": 17,
"specName": "默认",
"stockNum": "1",
"unitPrice": 1.0,
"goodsId": 8
}, {
"id": 18,
"specName": "45",
"stockNum": "34",
"unitPrice": 534.0,
"goodsId": 8
}],
"goods": {
"id": 8,
"img": "http://localhost:8084/static/image/70ad3d60-c0bb-43b1-802b-acc0845af1ad-IMG_PITU_20200325_091153.jpg",
"name": "1315",
"typeId": 1,
"desc": "大王的哇大阿瓦德"
}
}
}
```
#### 7.添加规格
##### (1)接口说明
编辑时添加规格
##### (2)请求方式
POST
##### (3)Uri
/api/admin/goods/addSpec
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| --------- | -------- | -------- | ------ |
| goodsId | int | 1 | 商品id |
| specName | str | 1 | 规格名 |
| stockNum | int | 1 | 库存量 |
| unitPrice | double | 1 | 单价 |
**示例:**
```json
{
"goodsId": "8",
"specName": "两个",
"stockNum": "16",
"unitPrice": "2.0"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"id": 0,
"specName": "两个",
"stockNum": "16",
"unitPrice": 2.0,
"goodsId": 8
}
}
```
#### 8.删除规格
##### (1)接口说明
编辑时删除规格
##### (2)请求方式
POST
##### (3)Uri
/api/admin/deleteSpec
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| -------- | -------- | -------- | ------ |
| goodsId | int | 1 | 商品id |
| specName | str | 1 | 规格名 |
**示例:**
```json
{
goodsId: "8",
specName: "两个"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 9.更新圣品
##### (1)接口说明
在编辑后更新圣品
##### (2)请求方式
POST
##### (3)Uri
/api/admin/goods/updateGoods
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| -------- | -------- | -------- | -------- |
| id | int | 1 | 商品id |
| name | str | 1 | 商品名 |
| typeId | int | 1 | 类型id |
| img | str | 1 | 图片地址 |
| desc | str | 1 | 描述 |
| specList | object | 1 | 规格表 |
**示例:**
```json
{
"id": "8",
"name": "1315",
"typeId": 1,
"img": "http://localhost:8084/static/image/70ad3d60-c0bb-43b1-802b-acc0845af1ad-IMG_PITU_20200325_091153.jpg",
"desc": "大王的哇大大王的的",
"specList": [{
"id": 17,
"specName": "默认",
"stockNum": "1",
"unitPrice": 1,
"goodsId": 8
}, {
"id": 18,
"specName": "45",
"stockNum": "34",
"unitPrice": 534,
"goodsId": 8
}]
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 10.删除商品
##### (1)接口说明
删除一个商品
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/deleteGoods
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
### 4.订单管理模块
#### 0.分页查询
##### (1)接口说明
分页查询订单信息
##### (2)请求方式
POST
##### (3)Uri
/api/admin/order/ordersByPage
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| address | str | 1 | 收货地址 |
| currentPage | int | 1 | 当前页 |
| goods | str | 1 | 商品名 |
| id | int | 1 | 订单号 |
| moneyLimit1 | double | 1 | 金额上限 |
| moneyLimit2 | double | 1 | 金额下限 |
| name |str|1| 用户昵称 |
| pageSize |int|1| 每页显示个数 |
| state |int|1| 订单状态,-1表示所有状态 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"total": 5,
"orders": [{
"id": 1,
"userId": 1,
"goodsDetailId": 1,
"goods": "茄子",
"goodsNum": 19,
"amount": 21.22,
"stateId": 1,
"state": "未发货",
"spec": "一只",
"user": {
"nickname": "gaattc",
"name": "awd",
"address": "武汉",
"phone": "18551811111"
}
}, {
"id": 2,
"userId": 1,
"goodsDetailId": 1,
"goods": "茄子",
"goodsNum": 21,
"amount": 21.22,
"stateId": 2,
"state": "已发货",
"spec": "一只",
"user": {
"nickname": "gaattc",
"name": "awd",
"address": "武汉",
"phone": "18551811111"
}
}, {
"id": 3,
"userId": 1,
"goodsDetailId": 1,
"goods": "茄子",
"goodsNum": 21,
"amount": 21.22,
"stateId": 2,
"state": "已发货",
"spec": "一只",
"user": {
"nickname": "gaattc",
"name": "awd",
"address": "武汉",
"phone": "18551811111"
}
}, {
"id": 4,
"userId": 1,
"goodsDetailId": 1,
"goods": "茄子",
"goodsNum": 21,
"amount": 21.22,
"stateId": 2,
"state": "已发货",
"spec": "一只",
"user": {
"nickname": "gaattc",
"name": "awd",
"address": "武汉",
"phone": "18551811111"
}
}, {
"id": 5,
"userId": 1,
"goodsDetailId": 1,
"goods": "茄子",
"goodsNum": 21,
"amount": 21.22,
"stateId": 2,
"state": "已发货",
"spec": "一只",
"user": {
"nickname": "gaattc",
"name": "awd",
"address": "武汉",
"phone": "18551811111"
}
}]
}
}
```
#### 1.删除订单
##### (1)接口说明
根据订单id删除订单
##### (2)请求方式
GET
##### (3)Uri
/api/admin/order/deleteOrder
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 2.获取订单信息
##### (1)接口说明
编辑订单时获取订单详细信息
##### (2)请求方式
POST
##### (3)Uri
/api/admin/order/order
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"id": 1,
"amount": 21.22,
"num": 19,
"goodsDetailId": 1,
"state": 1,
"goods": "茄子",
"goodsId": 1,
"spec": [{
"id": 1,
"specName": "一只",
"unitPrice": 100.0
}],
"specName": "一只",
"states": [{
"id": 0,
"name": "未付款"
}, {
"id": 1,
"name": "未发货"
}, {
"id": 2,
"name": "已发货"
}, {
"id": 3,
"name": "已完成订单"
}],
"curState": {
"id": 1,
"name": "未发货"
},
"curSpec": {
"id": 1,
"unitPrice": 0.0
}
}
}
```
#### 3.修改订单
##### (1)接口说明
修改订单信息(数量、规格、状态)
##### (2)请求方式
POST
##### (3)Uri
/api/admin/order/changeOrder
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| id | int | 1 | 订单号 |
| num | int | 1 | 订单中商品数 |
| spec |int|1| 商品规格 |
| state |int|1| 订单状态 |
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
### 5.留言管理模块
#### 0.未回复留言
##### (1)接口说明
获取所有未回复的留言
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/noReplyMsg
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"userId": 1,
"goodsId": 1,
"content": "测试测试",
"state": 1,
"createtime": "八月 10, 2020",
"goods": {
"name": "茄子"
},
"user": {
"name": "gaattc"
}
}]
}
```
#### 1.已回复留言
##### (1)接口说明
获取所有已回复的留言
##### (2)请求方式
GET
##### (3)Uri
/api/admin/goods/repliedMsg
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 2,
"userId": 2,
"goodsId": 1,
"content": "测试111",
"state": 0,
"createtime": "八月 9, 2020",
"replyContent": "测试回复111",
"goods": {
"name": "茄子"
},
"user": {
"name": "waddaw"
}
}, {
"id": 3,
"userId": 3,
"goodsId": 1,
"content": "测试测试222",
"state": 0,
"createtime": "八月 9, 2020",
"replyContent": "回复的信息是我哦",
"goods": {
"name": "茄子"
},
"user": {
"name": "sad"
}
}]
}
```
#### 2.回复留言
##### (1)接口说明
回复一条留言
##### (2)请求方式
POST
##### (3)Uri
/api/admin/admin/reply
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | -------- |
| id | int | 1 | 留言id |
| content | str | 1 | 回复内容 |
示例:
```json
{
"id": 1,
"content": "测试"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------- | -------- | -------- | --------------------- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
## 二.前台系统
### 1.商城首页模块
#### 0.获取商品类型
##### (1)接口说明
首页获取商品类型信息
##### (2)请求方式
GET
##### (3)Uri
/api/mall/index/getType
##### (4)请求参数
无
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"name": "女装"
}, {
"id": 2,
"name": "男装"
}, {
"id": 3,
"name": "电子产品"
}, {
"id": 5,
"name": "游戏"
}, {
"id": 9,
"name": "123"
}]
}
```
### 2.商品模块
#### 0.获取商品
##### (1)接口说明
根据类型获取商品
##### (2)请求方式
GET
##### (3)Uri
/api/mall/goods/getGoodsByType
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | | 返回的数据 |
| message | str | | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 2,
"img": "http://localhost:8084/static/image/liubo.jpg",
"name": "刘波",
"price": 5.0,
"typeId": 1,
"stockNum": 99
}, {
"id": 3,
"img": "http://localhost:8084/static/image/liubo.jpg",
"name": "药水",
"price": 31.0,
"typeId": 2,
"stockNum": 53
}, {
"id": 5,
"img": "http://localhost:8084/static/image/8357b07c-0bff-4383-8b6e-9f679a43f946-7d73faf2ac2ba1b9554576db6c0ca0d1042e03bd.jpg",
"name": "牛俊生",
"price": 10.0,
"typeId": 1,
"stockNum": 100
}, {
"id": 6,
"img": "http://localhost:8084/static/image/e5aa0d18-e16e-4611-9782-d9519c066b24-316-1F51G52212.jpg",
"name": "阿迪王",
"price": 22.0,
"typeId": 1,
"stockNum": 10
}, {
"id": 1,
"img": "http://localhost:8084/static/image/qiezi.jpg",
"name": "茄子",
"price": 15.0,
"typeId": 1,
"stockNum": 1535
}, {
"id": 9,
"img": "http://localhost:8084/static/image/26bce439-caea-4fba-88ba-ce1d78f7c828--5f1dceacc9b51001.jpg",
"name": "电子",
"price": 1000.0,
"typeId": 3,
"stockNum": 45
}, {
"id": 10,
"img": "http://localhost:8084/static/image/76965438-a61a-4f34-a455-070eb2aa1dce-1527424979594.jpg",
"name": "mute",
"price": 15.0,
"typeId": 5,
"stockNum": 453
}, {
"id": 11,
"img": "http://localhost:8084/static/image/c80bb4f9-6f50-452e-b6c5-2b75b8225081-5f3c155403850eaa.jpg",
"name": "茄子真不辍",
"price": 15.0,
"typeId": 1,
"stockNum": 100
}]
}
```
#### 1.获取商品信息
##### (1)接口说明
获取商品详细信息
##### (2)请求方式
GET
##### (3)Uri
/api/mall/goods/getGoodsInfo
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"specs": [{
"id": 2,
"specName": "一个",
"stockNum": "889",
"unitPrice": 25.0,
"goodsId": 2
}, {
"id": 3,
"specName": "两个",
"stockNum": "886",
"unitPrice": 49.0,
"goodsId": 2
}, {
"id": 5,
"specName": "三个",
"stockNum": "99",
"unitPrice": 5.0,
"goodsId": 2
}],
"id": 2,
"img": "http://localhost:8084/static/image/liubo.jpg",
"name": "刘波",
"typeId": 1,
"desc": "描述刘波"
}
}
```
#### 2.获取商品问答
##### (1)接口说明
详情页获取商品问答
##### (2)请求方式
GET
##### (3)Uri
/api/mall/goods/getGoodsMsg
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"userId": 1,
"content": "测试测试",
"asker": "gaattc",
"time": "八月 10, 2020",
"reply": {
"content": "阿瓦德瓦达",
"time": "八月 10, 2020"
},
"replyContent": "阿瓦德瓦达",
"replytime": "八月 10, 2020"
}, {
"id": 2,
"userId": 2,
"content": "测试111",
"asker": "waddaw",
"time": "八月 9, 2020",
"reply": {
"content": "测试回复111",
"time": "八月 10, 2020"
},
"replyContent": "测试回复111",
"replytime": "八月 10, 2020"
}, {
"id": 3,
"userId": 3,
"content": "测试测试222",
"asker": "sad",
"time": "八月 10, 2020",
"reply": {
"content": "513513153",
"time": "八月 10, 2020"
},
"replyContent": "513513153",
"replytime": "八月 10, 2020"
}, {
"id": 4,
"userId": 1,
"content": "测试空的",
"asker": "gaattc",
"time": "八月 10, 2020",
"reply": {
"content": "哇大大啊",
"time": "八月 10, 2020"
},
"replyContent": "哇大大啊",
"replytime": "八月 10, 2020"
}, {
"id": 5,
"userId": 2,
"content": "无回复测试",
"asker": "waddaw",
"time": "八月 11, 2020",
"reply": {}
}, {
"id": 6,
"userId": 7,
"content": "茄子我来了",
"asker": "admin1g",
"time": "八月 11, 2020",
"reply": {
"content": "茂名白给茄",
"time": "八月 11, 2020"
},
"replyContent": "茂名白给茄",
"replytime": "八月 11, 2020"
}]
}
```
#### 3.获取评价&评分
##### (1)接口说明
详情页获取商品评价和评分
##### (2)请求方式
GET
##### (3)Uri
/api/mall/goods/getGoodsComment
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"commentList": [{
"user": {
"nickname": "gaattc"
},
"score": 100.0,
"id": 1,
"specName": "一只",
"comment": "好评呀",
"time": "八月 10, 2020",
"userId": 1,
"nickname": "gaattc"
}, {
"user": {
"nickname": "gaattc"
},
"score": 80.0,
"id": 2,
"specName": "一只",
"comment": "好评呀1",
"time": "八月 10, 2020",
"userId": 1,
"nickname": "gaattc"
}, {
"user": {
"nickname": "admin"
},
"score": 80.0,
"id": 3,
"specName": "一只",
"comment": "真不错,好评",
"time": "八月 11, 2020",
"userId": 4,
"nickname": "admin"
}],
"rate": 86.666667
}
}
```
#### 4.搜索商品
##### (1)接口说明
根据关键字查询商品
##### (2)请求方式
GET
##### (3)Uri
/api/mall/goods/searchGoods
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 1,
"img": "http://localhost:8084/static/image/qiezi.jpg",
"name": "茄子",
"price": 15.0,
"typeId": 1,
"stockNum": 1535
}, {
"id": 11,
"img": "http://localhost:8084/static/image/c80bb4f9-6f50-452e-b6c5-2b75b8225081-5f3c155403850eaa.jpg",
"name": "茄子真不辍",
"price": 15.0,
"typeId": 1,
"stockNum": 100
}]
}
```
#### 5.商品提问
##### (1)接口说明
详情页发送提问
##### (2)请求方式
POST
##### (3)Uri
/api/mall/goods/askGoodsMsg
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| goodsId | int | 1 | 商品id |
| msg | str | 1 | 提问内容 |
| token |str|1| 用户token |
**示例:**
```json
{
"token": "admin",
"msg": "真不辍",
"goodsId": "11"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
### 3.用户模块
#### 0.用户登录
##### (1)接口说明
首页用户登录
##### (2)请求方式
POST
##### (3)Uri
/api/mall/user/login
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| email | str | 1 | 邮箱 |
| pwd | str | 1 | 密码 |
**示例:**
```json
{
"email":"admin",
"pwd":"admin"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | | 返回的数据 |
| message | str | | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"token": "admin",
"name": "admin"
}
}
```
#### 1.注销登录
##### (1)接口说明
用户注销登录
##### (2)请求方式
POST
##### (3)Uri
/api/mall/user/logoutClient
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| token | str | 1 | 用户token |
**示例:**
```json
{
"token": "admin"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 2.用户注册
##### (1)接口说明
新用户注册
##### (2)请求方式
POST
##### (3)Uri
/api/mall/user/signup
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| email | str | 1 | 邮箱 |
| nickname | str | 1 | 昵称 |
| pwd |str|1| 密码 |
| recipient |str|1| 收件人 |
| address |str|1| 地址 |
| phone |str|1| 电话 |
**示例:**
```json
{
"email": "8888888@qq.com",
"nickname": "nickname",
"pwd": "Qwe123000?",
"recipient": "姓名",
"address": "武汉",
"phone": "18645654689"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0,
"data": {
"code": 0,
"name": "8888888@qq.com",
"token": "8888888@qq.com"
}
}
```
#### 3.修改密码
##### (1)接口说明
用户修改密码
##### (2)请求方式
POST
##### (3)Uri
/api/mall/user/updatePwd
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| id | int | 1 | 用户id |
| oldPwd | str | 1 | 旧密码 |
| newPwd |str|1| 新密码 |
| confirmPwd |str|1| 确认密码 |
**示例:**
```json
{
"id": 8,
"oldPwd": "Qwe123000?",
"newPwd": "Admin123?",
"confirmPwd": "Admin123?"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 说明 |
**示例:**
```json
{
"code": 0
}
```
#### 4.修改资料
##### (1)接口说明
用户修改资料
##### (2)请求方式
POST
##### (3)Uri
/api/mall/user/updateUserData
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| id | int | 1 | 用户id |
| nickname | str | 1 | 昵称 |
| recipient |str|1| 收件人 |
| address |str|1| 地址 |
| phone |str|1| 电话 |
**示例:**
```json
{
"id": 8,
"nickname": "nickname1",
"recipient": "姓名",
"address": "武汉",
"phone": "18645654600"
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | |
| data | object | | |
| message | str | | |
**示例:**
```json
{
"code": 0
}
```
#### 5.获取用户信息
##### (1)接口说明
获取用户资料信息
##### (2)请求方式
GET
##### (3)Uri
/api/mall/mall/user/data
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0,
"data": {
"id": 8,
"email": "8888888@qq.com",
"nickname": "nickname1",
"pwd": "Admin123?",
"recipient": "姓名",
"address": "武汉",
"phone": "18645654600"
}
}
```
### 4.订单模块
#### 0.添加订单
##### (1)接口说明
添加订单到购物车或直接购买
##### (2)请求方式
POST
##### (3)Uri
/api/mall/order/addOrder
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| token | str | 1 | 用户token |
| goodsDetailId | int | 1 | 商品规格id |
| state |int|1| 订单状态 |
| num |int|1| 数量 |
| amount |double|1| 合计价格 |
**示例:**
```json
{
"token": "8888888@qq.com",
"goodsDetailId": 25,
"state": 0,
"num": 1,
"amount": 15
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0
}
```
#### 1.删除订单
##### (1)接口说明
用户删除订单
##### (2)请求方式
GET
##### (3)Uri
/api/mall/deleteOrder
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0
}
```
#### 2.提交订单
##### (1)接口说明
付款提交订单
##### (2)请求方式
POST
##### (3)Uri
/api/mall/order/settleAccounts
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| cartList | array | 1 | 订单集合 |
**示例:**
```json
{
"cartList": [{
"id": 17,
"goodsNum": 1,
"amount": 15
}, {
"id": 18,
"goodsNum": 3,
"amount": 75
}]
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0
}
```
#### 3.确认收货
##### (1)接口说明
用户确认收货
##### (2)请求方式
GET
##### (3)Uri
/api/mall/order/confirmReceive
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0
}
```
#### 4.获取订单
##### (1)接口说明
根据状态获取订单
##### (2)请求方式
GET
##### (3)Uri
/api/mall/getOrderByState
##### (4)请求参数
url参数
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 1 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0,
"data": [{
"id": 16,
"goodsDetailId": 25,
"goodsNum": 1,
"amount": 15.0,
"state": 1,
"createtime": "八月 11, 2020",
"hasComment": false,
"goods": {
"id": 10,
"img": "http://localhost:8084/static/image/76965438-a61a-4f34-a455-070eb2aa1dce-1527424979594.jpg",
"name": "mute",
"goodsDetailId": 25,
"spec": "干员",
"unitPrice": 15.0
}
}, {
"id": 17,
"goodsDetailId": 25,
"goodsNum": 1,
"amount": 15.0,
"state": 1,
"createtime": "八月 11, 2020",
"hasComment": false,
"goods": {
"id": 10,
"img": "http://localhost:8084/static/image/76965438-a61a-4f34-a455-070eb2aa1dce-1527424979594.jpg",
"name": "mute",
"goodsDetailId": 25,
"spec": "干员",
"unitPrice": 15.0
}
}]
}
```
#### 5.提交评价
##### (1)接口说明
提交商品评价
##### (2)请求方式
POST
##### (3)Uri
/api/mall/order/sendComment
##### (4)请求参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| token | str | 1 | 用户token |
| orderId | int | 1 | 订单id |
| goodsId |int|1| 商品id |
| goodsDetailId |int|1| 商品规格id |
| content |str|1| 评价内容 |
| score |int|1| 评分 |
**示例:**
```json
{
"token": "8888888@qq.com",
"orderId": 18,
"goodsId": 5,
"goodsDetailId": 8,
"content": "好评如潮!",
"score": 80
}
```
##### (5)返回参数
JSON
| 参数名 | 参数类型 | 是否必须 | 说明 |
| ------ | -------- | -------- | ---- |
| code | int | 1 | 返回状态码,0表示正常 |
| data | object | 0 | 返回的数据 |
| message | str | 0 | 信息 |
**示例:**
```json
{
"code": 0
}
```