# SSM_PET_STORE

**Repository Path**: wml_707/petStore_ssm

## Basic Information

- **Project Name**: SSM_PET_STORE
- **Description**: xasdahkdhjskadhajsd
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-07
- **Last Updated**: 2024-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SSM_PET_STORE

#### 介绍
宠物商店管理员端后端

#### 软件架构
软件架构说明
使用springboot+restfulAPI

#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 接口设计
# OrderController

OrderController


---
## showOrderDetail

> BASIC

**Path:** /orders/{id}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| id |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderId | integer |  |
|   |─orderDate | string |  |
|   |─items | array |  |
|     |─ | object |  |
|       |─name | string |  |
|       |─quantity | integer |  |
|       |─price | number |  |
|       |─imageSrc | string |  |
|       |─link | string |  |
|       |─description | string |  |
|       |─inStock | boolean |  |
|   |─totalCost | number |  |
|   |─username | string |  |
|   |─receiverName | string |  |
|   |─shipAddress | string |  |
|   |─phoneNumber | string |  |
| data2 | object |  |
|   |─orderId | integer |  |
|   |─orderDate | string |  |
|   |─items | array |  |
|     |─ | object |  |
|       |─name | string |  |
|       |─quantity | integer |  |
|       |─price | number |  |
|       |─imageSrc | string |  |
|       |─link | string |  |
|       |─description | string |  |
|       |─inStock | boolean |  |
|   |─totalCost | number |  |
|   |─username | string |  |
|   |─receiverName | string |  |
|   |─shipAddress | string |  |
|   |─phoneNumber | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderId": 0,
    "orderDate": "",
    "items": [
      {
        "name": "",
        "quantity": 0,
        "price": 0.0,
        "imageSrc": "",
        "link": "",
        "description": "",
        "inStock": false
      }
    ],
    "totalCost": 0.0,
    "username": "",
    "receiverName": "",
    "shipAddress": "",
    "phoneNumber": ""
  },
  "data2": {
    "orderId": 0,
    "orderDate": "",
    "items": [
      {
        "name": "",
        "quantity": 0,
        "price": 0.0,
        "imageSrc": "",
        "link": "",
        "description": "",
        "inStock": false
      }
    ],
    "totalCost": 0.0,
    "username": "",
    "receiverName": "",
    "shipAddress": "",
    "phoneNumber": ""
  }
}
```




---
## getOrders

> BASIC

**Path:** /orders

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| userId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─userId | string |  |
|       |─orderDate | string |  |
|       |─shipAddress | string |  |
|       |─totalPrice | number |  |
|       |─receiverName | string |  |
|       |─phoneNumber | string |  |
|       |─status | integer |  |
|       |─deliveryDate | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─userId | string |  |
|       |─orderDate | string |  |
|       |─shipAddress | string |  |
|       |─totalPrice | number |  |
|       |─receiverName | string |  |
|       |─phoneNumber | string |  |
|       |─status | integer |  |
|       |─deliveryDate | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "userId": "",
        "orderDate": "",
        "shipAddress": "",
        "totalPrice": 0.0,
        "receiverName": "",
        "phoneNumber": "",
        "status": 0,
        "deliveryDate": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "userId": "",
        "orderDate": "",
        "shipAddress": "",
        "totalPrice": 0.0,
        "receiverName": "",
        "phoneNumber": "",
        "status": 0,
        "deliveryDate": ""
      }
    ]
  }
}
```




---
## addOrder

> BASIC

**Path:** /orders

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| orderId | integer |  |
| userId | string |  |
| orderDate | string |  |
| shipAddress | string |  |
| totalPrice | number |  |
| receiverName | string |  |
| phoneNumber | string |  |
| status | integer |  |
| deliveryDate | string |  |

**Request Demo:**

```json
{
  "orderId": 0,
  "userId": "",
  "orderDate": "",
  "shipAddress": "",
  "totalPrice": 0.0,
  "receiverName": "",
  "phoneNumber": "",
  "status": 0,
  "deliveryDate": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |
| data2 | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  },
  "data2": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  }
}
```




---
## getOrderIds

> BASIC

**Path:** /orders/orderIds

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | integer |  |
| data2 | array |  |
|   |─ | integer |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    0
  ],
  "data2": [
    0
  ]
}
```




---
## deleteOrder

> BASIC

**Path:** /orders/{id}

**Method:** DELETE

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| id |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## updateOrder

> BASIC

**Path:** /orders/{id}

**Method:** PUT

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| id |  |  |

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| orderId | integer |  |
| userId | string |  |
| orderDate | string |  |
| shipAddress | string |  |
| totalPrice | number |  |
| receiverName | string |  |
| phoneNumber | string |  |
| status | integer |  |
| deliveryDate | string |  |

**Request Demo:**

```json
{
  "orderId": 0,
  "userId": "",
  "orderDate": "",
  "shipAddress": "",
  "totalPrice": 0.0,
  "receiverName": "",
  "phoneNumber": "",
  "status": 0,
  "deliveryDate": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |
| data2 | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  },
  "data2": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  }
}
```




---
## getLineItems

> BASIC

**Path:** /orders/lineItems

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| orderId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─lineNumber | integer |  |
|       |─quantity | integer |  |
|       |─itemId | string |  |
|       |─unitPrice | number |  |
|       |─item | object |  |
|         |─itemId | string |  |
|         |─productId | string |  |
|         |─listPrice | number |  |
|         |─unitCost | number |  |
|         |─supplierId | integer |  |
|         |─status | string |  |
|         |─attribute1 | string |  |
|         |─attribute2 | string |  |
|         |─attribute3 | string |  |
|         |─attribute4 | string |  |
|         |─attribute5 | string |  |
|         |─product | object |  |
|           |─productId | string |  |
|           |─categoryId | string |  |
|           |─name | string |  |
|           |─description | string |  |
|           |─imagePath | string |  |
|         |─quantity | integer |  |
|       |─total | number |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─lineNumber | integer |  |
|       |─quantity | integer |  |
|       |─itemId | string |  |
|       |─unitPrice | number |  |
|       |─item | object |  |
|         |─itemId | string |  |
|         |─productId | string |  |
|         |─listPrice | number |  |
|         |─unitCost | number |  |
|         |─supplierId | integer |  |
|         |─status | string |  |
|         |─attribute1 | string |  |
|         |─attribute2 | string |  |
|         |─attribute3 | string |  |
|         |─attribute4 | string |  |
|         |─attribute5 | string |  |
|         |─product | object |  |
|           |─productId | string |  |
|           |─categoryId | string |  |
|           |─name | string |  |
|           |─description | string |  |
|           |─imagePath | string |  |
|         |─quantity | integer |  |
|       |─total | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "lineNumber": 0,
        "quantity": 0,
        "itemId": "",
        "unitPrice": 0.0,
        "item": {
          "itemId": "",
          "productId": "",
          "listPrice": 0.0,
          "unitCost": 0.0,
          "supplierId": 0,
          "status": "",
          "attribute1": "",
          "attribute2": "",
          "attribute3": "",
          "attribute4": "",
          "attribute5": "",
          "product": {
            "productId": "",
            "categoryId": "",
            "name": "",
            "description": "",
            "imagePath": ""
          },
          "quantity": 0
        },
        "total": 0.0
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "lineNumber": 0,
        "quantity": 0,
        "itemId": "",
        "unitPrice": 0.0,
        "item": {
          "itemId": "",
          "productId": "",
          "listPrice": 0.0,
          "unitCost": 0.0,
          "supplierId": 0,
          "status": "",
          "attribute1": "",
          "attribute2": "",
          "attribute3": "",
          "attribute4": "",
          "attribute5": "",
          "product": {
            "productId": "",
            "categoryId": "",
            "name": "",
            "description": "",
            "imagePath": ""
          },
          "quantity": 0
        },
        "total": 0.0
      }
    ]
  }
}
```




---
## getLineItemListAndImage

> BASIC

**Path:** /orders/lineItems/images

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| orderId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─lineNumber | integer |  |
|       |─quantity | integer |  |
|       |─itemId | string |  |
|       |─unitPrice | number |  |
|       |─imagePath | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─orderId | integer |  |
|       |─lineNumber | integer |  |
|       |─quantity | integer |  |
|       |─itemId | string |  |
|       |─unitPrice | number |  |
|       |─imagePath | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "lineNumber": 0,
        "quantity": 0,
        "itemId": "",
        "unitPrice": 0.0,
        "imagePath": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "orderId": 0,
        "lineNumber": 0,
        "quantity": 0,
        "itemId": "",
        "unitPrice": 0.0,
        "imagePath": ""
      }
    ]
  }
}
```




---
## addLineItem

> BASIC

**Path:** /orders/lineItems

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| orderId | integer |  |
| lineNumber | integer |  |
| quantity | integer |  |
| itemId | string |  |
| unitPrice | number |  |
| item | object |  |
|   |─itemId | string |  |
|   |─productId | string |  |
|   |─listPrice | number |  |
|   |─unitCost | number |  |
|   |─supplierId | integer |  |
|   |─status | string |  |
|   |─attribute1 | string |  |
|   |─attribute2 | string |  |
|   |─attribute3 | string |  |
|   |─attribute4 | string |  |
|   |─attribute5 | string |  |
|   |─product | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |
|   |─quantity | integer |  |
| total | number |  |

**Request Demo:**

```json
{
  "orderId": 0,
  "lineNumber": 0,
  "quantity": 0,
  "itemId": "",
  "unitPrice": 0.0,
  "item": {
    "itemId": "",
    "productId": "",
    "listPrice": 0.0,
    "unitCost": 0.0,
    "supplierId": 0,
    "status": "",
    "attribute1": "",
    "attribute2": "",
    "attribute3": "",
    "attribute4": "",
    "attribute5": "",
    "product": {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    },
    "quantity": 0
  },
  "total": 0.0
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## deleteLineItem

> BASIC

**Path:** /orders/lineItems/{orderId}/{lineNum}

**Method:** DELETE

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| orderId |  |  |
| lineNum |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## updateLineItem

> BASIC

**Path:** /orders/lineItems

**Method:** PUT

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| orderId | integer |  |
| lineNumber | integer |  |
| quantity | integer |  |
| itemId | string |  |
| unitPrice | number |  |
| item | object |  |
|   |─itemId | string |  |
|   |─productId | string |  |
|   |─listPrice | number |  |
|   |─unitCost | number |  |
|   |─supplierId | integer |  |
|   |─status | string |  |
|   |─attribute1 | string |  |
|   |─attribute2 | string |  |
|   |─attribute3 | string |  |
|   |─attribute4 | string |  |
|   |─attribute5 | string |  |
|   |─product | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |
|   |─quantity | integer |  |
| total | number |  |

**Request Demo:**

```json
{
  "orderId": 0,
  "lineNumber": 0,
  "quantity": 0,
  "itemId": "",
  "unitPrice": 0.0,
  "item": {
    "itemId": "",
    "productId": "",
    "listPrice": 0.0,
    "unitCost": 0.0,
    "supplierId": 0,
    "status": "",
    "attribute1": "",
    "attribute2": "",
    "attribute3": "",
    "attribute4": "",
    "attribute5": "",
    "product": {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    },
    "quantity": 0
  },
  "total": 0.0
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## changeOrderStatus

> BASIC

**Path:** /orders/changeOrderStatus

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| orderId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## getDayOrderChange

> BASIC

**Path:** /orders/todayOrder/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─num | integer |  |
|   |─trend | string |  |
|   |─percentage | number |  |
| data2 | object |  |
|   |─num | integer |  |
|   |─trend | string |  |
|   |─percentage | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "num": 0,
    "trend": "",
    "percentage": 0.0
  },
  "data2": {
    "num": 0,
    "trend": "",
    "percentage": 0.0
  }
}
```




---
## getDaySaleChange

> BASIC

**Path:** /orders/sales/day/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |
| data2 | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  },
  "data2": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  }
}
```




---
## getMonthSaleChange

> BASIC

**Path:** /orders/sales/month/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |
| data2 | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  },
  "data2": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  }
}
```




---
## getWeekSales

> BASIC

**Path:** /orders/sales/week/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | object |  |
|     |─x | string |  |
|     |─y | number |  |
| data2 | array |  |
|   |─ | object |  |
|     |─x | string |  |
|     |─y | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    {
      "x": "",
      "y": 0.0
    }
  ],
  "data2": [
    {
      "x": "",
      "y": 0.0
    }
  ]
}
```




---
## getDayProfitChange

> BASIC

**Path:** /orders/profit/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |
| data2 | object |  |
|   |─num | number |  |
|   |─trend | string |  |
|   |─percentage | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  },
  "data2": {
    "num": 0.0,
    "trend": "",
    "percentage": 0.0
  }
}
```




---
## getHomeDate

> BASIC

**Path:** /orders/homeData/{date}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| date |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderAmount | integer |  |
|   |─orderTrend | string |  |
|   |─orderPercentage | number |  |
|   |─profitsToday | number |  |
|   |─profitsTrend | string |  |
|   |─profitsPercentage | number |  |
|   |─salesToday | number |  |
|   |─salesTodayTrend | string |  |
|   |─salesTodayPercentage | number |  |
|   |─salesMonth | number |  |
|   |─salesMonthTrend | string |  |
|   |─salesMonthPercentage | number |  |
| data2 | object |  |
|   |─orderAmount | integer |  |
|   |─orderTrend | string |  |
|   |─orderPercentage | number |  |
|   |─profitsToday | number |  |
|   |─profitsTrend | string |  |
|   |─profitsPercentage | number |  |
|   |─salesToday | number |  |
|   |─salesTodayTrend | string |  |
|   |─salesTodayPercentage | number |  |
|   |─salesMonth | number |  |
|   |─salesMonthTrend | string |  |
|   |─salesMonthPercentage | number |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderAmount": 0,
    "orderTrend": "",
    "orderPercentage": 0.0,
    "profitsToday": 0.0,
    "profitsTrend": "",
    "profitsPercentage": 0.0,
    "salesToday": 0.0,
    "salesTodayTrend": "",
    "salesTodayPercentage": 0.0,
    "salesMonth": 0.0,
    "salesMonthTrend": "",
    "salesMonthPercentage": 0.0
  },
  "data2": {
    "orderAmount": 0,
    "orderTrend": "",
    "orderPercentage": 0.0,
    "profitsToday": 0.0,
    "profitsTrend": "",
    "profitsPercentage": 0.0,
    "salesToday": 0.0,
    "salesTodayTrend": "",
    "salesTodayPercentage": 0.0,
    "salesMonth": 0.0,
    "salesMonthTrend": "",
    "salesMonthPercentage": 0.0
  }
}
```



# AccountController

AccountController


---
## renewAccount

> BASIC

**Path:** /account/updateAccount

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| username | string |  |
| password | string |  |
| email | string |  |
| firstName | string |  |
| lastName | string |  |
| sex | string |  |
| status | string |  |
| city | string |  |
| state | string |  |
| zip | string |  |
| country | string |  |
| phone | string |  |
| favouriteCategoryId | string |  |
| languagePreference | string |  |
| listOption | boolean |  |
| bannerOption | boolean |  |

**Request Demo:**

```json
{
  "username": "",
  "password": "",
  "email": "",
  "firstName": "",
  "lastName": "",
  "sex": "",
  "status": "",
  "city": "",
  "state": "",
  "zip": "",
  "country": "",
  "phone": "",
  "favouriteCategoryId": "",
  "languagePreference": "",
  "listOption": false,
  "bannerOption": false
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## getAccountList

> BASIC

**Path:** /account/getAccountList

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| userId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─username | string |  |
|       |─password | string |  |
|       |─email | string |  |
|       |─firstName | string |  |
|       |─lastName | string |  |
|       |─sex | string |  |
|       |─status | string |  |
|       |─city | string |  |
|       |─state | string |  |
|       |─zip | string |  |
|       |─country | string |  |
|       |─phone | string |  |
|       |─favouriteCategoryId | string |  |
|       |─languagePreference | string |  |
|       |─listOption | boolean |  |
|       |─bannerOption | boolean |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─username | string |  |
|       |─password | string |  |
|       |─email | string |  |
|       |─firstName | string |  |
|       |─lastName | string |  |
|       |─sex | string |  |
|       |─status | string |  |
|       |─city | string |  |
|       |─state | string |  |
|       |─zip | string |  |
|       |─country | string |  |
|       |─phone | string |  |
|       |─favouriteCategoryId | string |  |
|       |─languagePreference | string |  |
|       |─listOption | boolean |  |
|       |─bannerOption | boolean |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "username": "",
        "password": "",
        "email": "",
        "firstName": "",
        "lastName": "",
        "sex": "",
        "status": "",
        "city": "",
        "state": "",
        "zip": "",
        "country": "",
        "phone": "",
        "favouriteCategoryId": "",
        "languagePreference": "",
        "listOption": false,
        "bannerOption": false
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "username": "",
        "password": "",
        "email": "",
        "firstName": "",
        "lastName": "",
        "sex": "",
        "status": "",
        "city": "",
        "state": "",
        "zip": "",
        "country": "",
        "phone": "",
        "favouriteCategoryId": "",
        "languagePreference": "",
        "listOption": false,
        "bannerOption": false
      }
    ]
  }
}
```




---
## deleteAccount

> BASIC

**Path:** /account/delAccount

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| userId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## addAccount

> BASIC

**Path:** /account/addAccount

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| username | string |  |
| password | string |  |
| email | string |  |
| firstName | string |  |
| lastName | string |  |
| sex | string |  |
| status | string |  |
| city | string |  |
| state | string |  |
| zip | string |  |
| country | string |  |
| phone | string |  |
| favouriteCategoryId | string |  |
| languagePreference | string |  |
| listOption | boolean |  |
| bannerOption | boolean |  |

**Request Demo:**

```json
{
  "username": "",
  "password": "",
  "email": "",
  "firstName": "",
  "lastName": "",
  "sex": "",
  "status": "",
  "city": "",
  "state": "",
  "zip": "",
  "country": "",
  "phone": "",
  "favouriteCategoryId": "",
  "languagePreference": "",
  "listOption": false,
  "bannerOption": false
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─username | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─firstName | string |  |
|   |─lastName | string |  |
|   |─sex | string |  |
|   |─status | string |  |
|   |─city | string |  |
|   |─state | string |  |
|   |─zip | string |  |
|   |─country | string |  |
|   |─phone | string |  |
|   |─favouriteCategoryId | string |  |
|   |─languagePreference | string |  |
|   |─listOption | boolean |  |
|   |─bannerOption | boolean |  |
| data2 | object |  |
|   |─username | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─firstName | string |  |
|   |─lastName | string |  |
|   |─sex | string |  |
|   |─status | string |  |
|   |─city | string |  |
|   |─state | string |  |
|   |─zip | string |  |
|   |─country | string |  |
|   |─phone | string |  |
|   |─favouriteCategoryId | string |  |
|   |─languagePreference | string |  |
|   |─listOption | boolean |  |
|   |─bannerOption | boolean |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "username": "",
    "password": "",
    "email": "",
    "firstName": "",
    "lastName": "",
    "sex": "",
    "status": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone": "",
    "favouriteCategoryId": "",
    "languagePreference": "",
    "listOption": false,
    "bannerOption": false
  },
  "data2": {
    "username": "",
    "password": "",
    "email": "",
    "firstName": "",
    "lastName": "",
    "sex": "",
    "status": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone": "",
    "favouriteCategoryId": "",
    "languagePreference": "",
    "listOption": false,
    "bannerOption": false
  }
}
```




---
## getAccountByUsername

> BASIC

**Path:** /account/{username}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| username |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─username | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─firstName | string |  |
|   |─lastName | string |  |
|   |─sex | string |  |
|   |─status | string |  |
|   |─city | string |  |
|   |─state | string |  |
|   |─zip | string |  |
|   |─country | string |  |
|   |─phone | string |  |
|   |─favouriteCategoryId | string |  |
|   |─languagePreference | string |  |
|   |─listOption | boolean |  |
|   |─bannerOption | boolean |  |
| data2 | object |  |
|   |─username | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─firstName | string |  |
|   |─lastName | string |  |
|   |─sex | string |  |
|   |─status | string |  |
|   |─city | string |  |
|   |─state | string |  |
|   |─zip | string |  |
|   |─country | string |  |
|   |─phone | string |  |
|   |─favouriteCategoryId | string |  |
|   |─languagePreference | string |  |
|   |─listOption | boolean |  |
|   |─bannerOption | boolean |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "username": "",
    "password": "",
    "email": "",
    "firstName": "",
    "lastName": "",
    "sex": "",
    "status": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone": "",
    "favouriteCategoryId": "",
    "languagePreference": "",
    "listOption": false,
    "bannerOption": false
  },
  "data2": {
    "username": "",
    "password": "",
    "email": "",
    "firstName": "",
    "lastName": "",
    "sex": "",
    "status": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone": "",
    "favouriteCategoryId": "",
    "languagePreference": "",
    "listOption": false,
    "bannerOption": false
  }
}
```

# AdminController

AdminController


---
## getAdminList

> BASIC

**Path:** /admin/getAdminList

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| adminId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─adminId | string |  |
|       |─password | string |  |
|       |─email | string |  |
|       |─emailCode | string |  |
|       |─createAt | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─adminId | string |  |
|       |─password | string |  |
|       |─email | string |  |
|       |─emailCode | string |  |
|       |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "adminId": "",
        "password": "",
        "email": "",
        "emailCode": "",
        "createAt": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "adminId": "",
        "password": "",
        "email": "",
        "emailCode": "",
        "createAt": ""
      }
    ]
  }
}
```




---
## getAdminByAdminId

> BASIC

**Path:** /admin/{adminId}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| adminId |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |
| data2 | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  },
  "data2": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  }
}
```




---
## deleteAdmin

> BASIC

**Path:** /admin/deleteAdmin

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| adminId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## renewAdmin

> BASIC

**Path:** /admin/updateAdmin

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| adminId | string |  |
| password | string |  |
| email | string |  |
| emailCode | string |  |
| createAt | string |  |

**Request Demo:**

```json
{
  "adminId": "",
  "password": "",
  "email": "",
  "emailCode": "",
  "createAt": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## addAdmin

> BASIC

**Path:** /admin/addAdmin

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| adminId | string |  |
| password | string |  |
| email | string |  |
| emailCode | string |  |
| createAt | string |  |

**Request Demo:**

```json
{
  "adminId": "",
  "password": "",
  "email": "",
  "emailCode": "",
  "createAt": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |
| data2 | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  },
  "data2": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  }
}
```




---
## signOnAdminByEmail

> BASIC

**Path:** /admin/loginEmail

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| email |  | YES |  |
| verificationCode |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |
| data2 | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  },
  "data2": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  }
}
```




---
## getAdminByEMAIL

> BASIC

**Path:** /admin/getAdminByEmail

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| email |  | YES |  |
| verificationCode |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |
| data2 | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  },
  "data2": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  }
}
```




---
## signOnAdminByVerification

> BASIC

**Path:** /admin/loginAdmin

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| adminId |  | YES |  |
| password |  | YES |  |
| captcha |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |
| data2 | object |  |
|   |─adminId | string |  |
|   |─password | string |  |
|   |─email | string |  |
|   |─emailCode | string |  |
|   |─createAt | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  },
  "data2": {
    "adminId": "",
    "password": "",
    "email": "",
    "emailCode": "",
    "createAt": ""
  }
}
```




---
## sendVerificationCode

> BASIC

**Path:** /admin/sendVerificationCode

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| email |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## resetPassword

> BASIC

**Path:** /admin/resetPassword

**Method:** PUT

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| adminId | string |  |
| password | string |  |
| email | string |  |
| emailCode | string |  |
| createAt | string |  |

**Request Demo:**

```json
{
  "adminId": "",
  "password": "",
  "email": "",
  "emailCode": "",
  "createAt": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```



# CategoryController

CategoryController


---
## getCategoryList

> BASIC

**Path:** /category/getCategorys

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─categoryId | string |  |
|       |─name | string |  |
|       |─description | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─categoryId | string |  |
|       |─name | string |  |
|       |─description | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "categoryId": "",
        "name": "",
        "description": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "categoryId": "",
        "name": "",
        "description": ""
      }
    ]
  }
}
```




---
## deleteCategory

> BASIC

**Path:** /category/deleteCategory

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| catId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## updateCategory

> BASIC

**Path:** /category/updateCategory

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| categoryId | string |  |
| name | string |  |
| description | string |  |

**Request Demo:**

```json
{
  "categoryId": "",
  "name": "",
  "description": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## addCategory

> BASIC

**Path:** /category/addCategory

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| categoryId | string |  |
| name | string |  |
| description | string |  |

**Request Demo:**

```json
{
  "categoryId": "",
  "name": "",
  "description": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## getAllCategory

> BASIC

**Path:** /category/getAllCategory

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | object |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
| data2 | array |  |
|   |─ | object |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    {
      "categoryId": "",
      "name": "",
      "description": ""
    }
  ],
  "data2": [
    {
      "categoryId": "",
      "name": "",
      "description": ""
    }
  ]
}
```




---
## getAllCategoryId

> BASIC

**Path:** /category/getAllCategoryId

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | string |  |
| data2 | array |  |
|   |─ | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    ""
  ],
  "data2": [
    ""
  ]
}
```




---
## categoryId

> BASIC

**Path:** /category/{categoryId}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| categoryId |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |
| data2 | object |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "categoryId": "",
    "name": "",
    "description": ""
  },
  "data2": {
    "categoryId": "",
    "name": "",
    "description": ""
  }
}
```




---
## counts

> BASIC

**Path:** /category/counts

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─key | integer |  |
| data2 | object |  |
|   |─key | integer |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "": 0
  },
  "data2": {
    "": 0
  }
}
```



# ItemController

ItemController


---
## getItems

> BASIC

**Path:** /item/getItemList

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| productId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─itemId | string |  |
|       |─productId | string |  |
|       |─listPrice | number |  |
|       |─unitCost | number |  |
|       |─supplierId | integer |  |
|       |─status | string |  |
|       |─attribute1 | string |  |
|       |─attribute2 | string |  |
|       |─attribute3 | string |  |
|       |─attribute4 | string |  |
|       |─attribute5 | string |  |
|       |─product | object |  |
|         |─productId | string |  |
|         |─categoryId | string |  |
|         |─name | string |  |
|         |─description | string |  |
|         |─imagePath | string |  |
|       |─quantity | integer |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─itemId | string |  |
|       |─productId | string |  |
|       |─listPrice | number |  |
|       |─unitCost | number |  |
|       |─supplierId | integer |  |
|       |─status | string |  |
|       |─attribute1 | string |  |
|       |─attribute2 | string |  |
|       |─attribute3 | string |  |
|       |─attribute4 | string |  |
|       |─attribute5 | string |  |
|       |─product | object |  |
|         |─productId | string |  |
|         |─categoryId | string |  |
|         |─name | string |  |
|         |─description | string |  |
|         |─imagePath | string |  |
|       |─quantity | integer |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "itemId": "",
        "productId": "",
        "listPrice": 0.0,
        "unitCost": 0.0,
        "supplierId": 0,
        "status": "",
        "attribute1": "",
        "attribute2": "",
        "attribute3": "",
        "attribute4": "",
        "attribute5": "",
        "product": {
          "productId": "",
          "categoryId": "",
          "name": "",
          "description": "",
          "imagePath": ""
        },
        "quantity": 0
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "itemId": "",
        "productId": "",
        "listPrice": 0.0,
        "unitCost": 0.0,
        "supplierId": 0,
        "status": "",
        "attribute1": "",
        "attribute2": "",
        "attribute3": "",
        "attribute4": "",
        "attribute5": "",
        "product": {
          "productId": "",
          "categoryId": "",
          "name": "",
          "description": "",
          "imagePath": ""
        },
        "quantity": 0
      }
    ]
  }
}
```




---
## deleteItem

> BASIC

**Path:** /item/deleteItem

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| itemId |  | YES |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## updateItem

> BASIC

**Path:** /item/updateItem

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| itemId | string |  |
| productId | string |  |
| listPrice | number |  |
| unitCost | number |  |
| supplierId | integer |  |
| status | string |  |
| attribute1 | string |  |
| attribute2 | string |  |
| attribute3 | string |  |
| attribute4 | string |  |
| attribute5 | string |  |
| product | object |  |
|   |─productId | string |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |
|   |─imagePath | string |  |
| quantity | integer |  |

**Request Demo:**

```json
{
  "itemId": "",
  "productId": "",
  "listPrice": 0.0,
  "unitCost": 0.0,
  "supplierId": 0,
  "status": "",
  "attribute1": "",
  "attribute2": "",
  "attribute3": "",
  "attribute4": "",
  "attribute5": "",
  "product": {
    "productId": "",
    "categoryId": "",
    "name": "",
    "description": "",
    "imagePath": ""
  },
  "quantity": 0
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## addItem

> BASIC

**Path:** /item/addItem

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| itemId | string |  |
| productId | string |  |
| listPrice | number |  |
| unitCost | number |  |
| supplierId | integer |  |
| status | string |  |
| attribute1 | string |  |
| attribute2 | string |  |
| attribute3 | string |  |
| attribute4 | string |  |
| attribute5 | string |  |
| product | object |  |
|   |─productId | string |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |
|   |─imagePath | string |  |
| quantity | integer |  |

**Request Demo:**

```json
{
  "itemId": "",
  "productId": "",
  "listPrice": 0.0,
  "unitCost": 0.0,
  "supplierId": 0,
  "status": "",
  "attribute1": "",
  "attribute2": "",
  "attribute3": "",
  "attribute4": "",
  "attribute5": "",
  "product": {
    "productId": "",
    "categoryId": "",
    "name": "",
    "description": "",
    "imagePath": ""
  },
  "quantity": 0
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## decreaseQuantity

> BASIC

**Path:** /item/decreaseQuantity

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| itemId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## increaseQuantity

> BASIC

**Path:** /item/increaseQuantity

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| itemId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## itemIds

> BASIC

**Path:** /item/itemIds

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | string |  |
| data2 | array |  |
|   |─ | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    ""
  ],
  "data2": [
    ""
  ]
}
```




---
## item

> BASIC

**Path:** /item/{itemId}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| itemId |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─itemId | string |  |
|   |─productId | string |  |
|   |─listPrice | number |  |
|   |─unitCost | number |  |
|   |─supplierId | integer |  |
|   |─status | string |  |
|   |─attribute1 | string |  |
|   |─attribute2 | string |  |
|   |─attribute3 | string |  |
|   |─attribute4 | string |  |
|   |─attribute5 | string |  |
|   |─product | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |
|   |─quantity | integer |  |
| data2 | object |  |
|   |─itemId | string |  |
|   |─productId | string |  |
|   |─listPrice | number |  |
|   |─unitCost | number |  |
|   |─supplierId | integer |  |
|   |─status | string |  |
|   |─attribute1 | string |  |
|   |─attribute2 | string |  |
|   |─attribute3 | string |  |
|   |─attribute4 | string |  |
|   |─attribute5 | string |  |
|   |─product | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |
|   |─quantity | integer |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "itemId": "",
    "productId": "",
    "listPrice": 0.0,
    "unitCost": 0.0,
    "supplierId": 0,
    "status": "",
    "attribute1": "",
    "attribute2": "",
    "attribute3": "",
    "attribute4": "",
    "attribute5": "",
    "product": {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    },
    "quantity": 0
  },
  "data2": {
    "itemId": "",
    "productId": "",
    "listPrice": 0.0,
    "unitCost": 0.0,
    "supplierId": 0,
    "status": "",
    "attribute1": "",
    "attribute2": "",
    "attribute3": "",
    "attribute4": "",
    "attribute5": "",
    "product": {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    },
    "quantity": 0
  }
}
```



# LogController

LogController


---
## getLoggers

> BASIC

**Path:** /log/getLoggers

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| userId |  | NO |  |
| operate |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─id | integer |  |
|       |─username | string |  |
|       |─operate | string |  |
|       |─action | string |  |
|       |─date | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─id | integer |  |
|       |─username | string |  |
|       |─operate | string |  |
|       |─action | string |  |
|       |─date | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "id": 0,
        "username": "",
        "operate": "",
        "action": "",
        "date": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "id": 0,
        "username": "",
        "operate": "",
        "action": "",
        "date": ""
      }
    ]
  }
}
```




---
## deleteLogger

> BASIC

**Path:** /log/deleteLogger

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| loggerId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## save

> BASIC

**Path:** /log/

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| id | integer |  |
| username | string |  |
| operate | string |  |
| action | string |  |
| date | string |  |

**Request Demo:**

```json
{
  "id": 0,
  "username": "",
  "operate": "",
  "action": "",
  "date": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```



# ProductController

ProductController


---
## getProducts

> BASIC

**Path:** /product/getProducts

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| pageNum |  | YES |  |
| pageSize |  | YES |  |
| category |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─productId | string |  |
|       |─categoryId | string |  |
|       |─name | string |  |
|       |─description | string |  |
|       |─imagePath | string |  |
| data2 | object |  |
|   |─total | integer |  |
|   |─data | array |  |
|     |─ | object |  |
|       |─productId | string |  |
|       |─categoryId | string |  |
|       |─name | string |  |
|       |─description | string |  |
|       |─imagePath | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "total": 0,
    "data": [
      {
        "productId": "",
        "categoryId": "",
        "name": "",
        "description": "",
        "imagePath": ""
      }
    ]
  },
  "data2": {
    "total": 0,
    "data": [
      {
        "productId": "",
        "categoryId": "",
        "name": "",
        "description": "",
        "imagePath": ""
      }
    ]
  }
}
```




---
## getAllProducts

> BASIC

**Path:** /product/getAllProducts

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |
| data2 | array |  |
|   |─ | object |  |
|     |─productId | string |  |
|     |─categoryId | string |  |
|     |─name | string |  |
|     |─description | string |  |
|     |─imagePath | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    }
  ],
  "data2": [
    {
      "productId": "",
      "categoryId": "",
      "name": "",
      "description": "",
      "imagePath": ""
    }
  ]
}
```




---
## getAllProductId

> BASIC

**Path:** /product/getAllProductId

**Method:** GET

> REQUEST



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | array |  |
|   |─ | string |  |
| data2 | array |  |
|   |─ | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": [
    ""
  ],
  "data2": [
    ""
  ]
}
```




---
## addProduct

> BASIC

**Path:** /product/addProduct

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| productId | string |  |
| categoryId | string |  |
| name | string |  |
| description | string |  |
| imagePath | string |  |

**Request Demo:**

```json
{
  "productId": "",
  "categoryId": "",
  "name": "",
  "description": "",
  "imagePath": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |
| data2 | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  },
  "data2": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  }
}
```




---
## deleteProduct

> BASIC

**Path:** /product/deleteProduct

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| productId |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
| data2 | object |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {},
  "data2": {}
}
```




---
## updateProduct

> BASIC

**Path:** /product/updateProduct

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | application/json | YES |  |

**Request Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| productId | string |  |
| categoryId | string |  |
| name | string |  |
| description | string |  |
| imagePath | string |  |

**Request Demo:**

```json
{
  "productId": "",
  "categoryId": "",
  "name": "",
  "description": "",
  "imagePath": ""
}
```



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |
| data2 | object |  |
|   |─orderId | integer |  |
|   |─userId | string |  |
|   |─orderDate | string |  |
|   |─shipAddress | string |  |
|   |─totalPrice | number |  |
|   |─receiverName | string |  |
|   |─phoneNumber | string |  |
|   |─status | integer |  |
|   |─deliveryDate | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  },
  "data2": {
    "orderId": 0,
    "userId": "",
    "orderDate": "",
    "shipAddress": "",
    "totalPrice": 0.0,
    "receiverName": "",
    "phoneNumber": "",
    "status": 0,
    "deliveryDate": ""
  }
}
```




---
## getImg

> BASIC

**Path:** /product/getImage

**Method:** GET

> REQUEST

**Query:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| imagePath |  | NO |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
|  | array |  |
|  | number |  |

**Response Demo:**

```json
[
  0
]
```




---
## uploadImage

> BASIC

**Path:** /product/uploadImage

**Method:** POST

> REQUEST

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| Content-Type | multipart/form-data | YES |  |

**Form:**

| name | value | required | type | desc |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| image |  | YES | file |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
|  | string |  |

**Response Demo:**

```json

```




---
## productId

> BASIC

**Path:** /product/{productId}

**Method:** GET

> REQUEST

**Path Params:**

| name | value | desc |
| ------------ | ------------ | ------------ |
| productId |  |  |



> RESPONSE

**Headers:**

| name | value | required | desc |
| ------------ | ------------ | ------------ | ------------ |
| content-type | application/json;charset=UTF-8 | NO |  |

**Body:**

| name | type | desc |
| ------------ | ------------ | ------------ |
| status | integer |  |
| message | string |  |
| data | object |  |
|   |─productId | string |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |
|   |─imagePath | string |  |
| data2 | object |  |
|   |─productId | string |  |
|   |─categoryId | string |  |
|   |─name | string |  |
|   |─description | string |  |
|   |─imagePath | string |  |

**Response Demo:**

```json
{
  "status": 0,
  "message": "",
  "data": {
    "productId": "",
    "categoryId": "",
    "name": "",
    "description": "",
    "imagePath": ""
  },
  "data2": {
    "productId": "",
    "categoryId": "",
    "name": "",
    "description": "",
    "imagePath": ""
  }
}
```








#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)