diff --git a/.idea/.gitignore b/.idea/.gitignore
index 13566b8..35410ca 100644
--- a/.idea/.gitignore
+++ b/.idea/.gitignore
@@ -1,7 +1,7 @@
-# Default ignored files
+# 默认忽略的文件
/shelf/
/workspace.xml
-# Editor-based HTTP Client requests
+# 基于编辑器的 HTTP 客户端请求
/httpRequests/
# Datasource local storage ignored files
/dataSources/
diff --git a/.idea/cangqiong-takeout-master.iml b/.idea/cangqiong-takeout-master.iml
new file mode 100644
index 0000000..d6ebd48
--- /dev/null
+++ b/.idea/cangqiong-takeout-master.iml
@@ -0,0 +1,9 @@
+
+
Path: /admin/category
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 必须 | 分类id | format: int64 | |
name | string | 必须 | 分类名称 | ||
sort | integer | 必须 | 排序 | format: int32 | |
type | integer | 必须 | 分类类型 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/category/page
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
name | +否 | +传统主食 | +分类名称 | +
page | +是 | +1 | +页码 | +
pageSize | +是 | +10 | +每页记录数 | +
type | +否 | +1 | +分类类型:1为菜品分类,2为套餐分类 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 必须 | |||
msg | null | 非必须 | |||
data | object | 必须 | |||
├─ total | number | 必须 | |||
├─ records | object [] | 必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ type | number | 必须 | |||
├─ name | string | 必须 | |||
├─ sort | number | 必须 | |||
├─ status | number | 必须 | |||
├─ createTime | string | 必须 | |||
├─ updateTime | string | 必须 | |||
├─ createUser | number | 必须 | |||
├─ updateUser | number | 必须 |
Path: /admin/category/status/{status}
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
status | +1 | +1为启用,0为禁用 | +
Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
id | +是 | +100 | +分类id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/category
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 非必须 | format: int64 | ||
name | string | 必须 | 分类名称 | ||
sort | integer | 必须 | 排序,按照升序排序 | format: int32 | |
type | integer | 必须 | 分类类型:1为菜品分类,2为套餐分类 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/category
+Method: DELETE
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
id | +是 | +100 | +分类id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/category/list
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
type | +否 | +2 | +分类类型:1为菜品分类,2为套餐分类 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ createTime | string | 非必须 | format: date-time | ||
├─ createUser | integer | 非必须 | format: int64 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ name | string | 非必须 | |||
├─ sort | integer | 非必须 | format: int32 | ||
├─ status | integer | 非必须 | format: int32 | ||
├─ type | integer | 非必须 | format: int32 | ||
├─ updateTime | string | 非必须 | format: date-time | ||
├─ updateUser | integer | 非必须 | format: int64 | ||
msg | string | 非必须 |
Path: /admin/employee/editPassword
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
empId | integer | 必须 | 员工id | format: int64 | |
newPassword | string | 必须 | 新密码 | ||
oldPassword | string | 必须 | 旧密码 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/employee/status/{status}
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
status | +1 | +状态,1为启用 0为禁用 | +
Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
id | +是 | ++ | 员工id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/employee/page
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
name | +否 | +张三 | +员工姓名 | +
page | +是 | +1 | +页码 | +
pageSize | +是 | +10 | +每页记录数 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 必须 | |||
msg | null | 非必须 | |||
data | object | 必须 | |||
├─ total | number | 必须 | |||
├─ records | object [] | 必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ username | string | 必须 | |||
├─ name | string | 必须 | |||
├─ password | string | 必须 | |||
├─ phone | string | 必须 | |||
├─ sex | string | 必须 | |||
├─ idNumber | string | 必须 | |||
├─ status | number | 必须 | |||
├─ createTime | string,null | 必须 | |||
├─ updateTime | string | 必须 | |||
├─ createUser | number,null | 必须 | |||
├─ updateUser | number | 必须 |
Path: /admin/employee/login
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
password | string | 必须 | 密码 | ||
username | string | 必须 | 用户名 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | 员工登录返回的数据格式 | ||
├─ id | integer | 非必须 | 主键值 | format: int64 | |
├─ name | string | 非必须 | 姓名 | ||
├─ token | string | 非必须 | jwt令牌 | ||
├─ userName | string | 非必须 | 用户名 | ||
msg | string | 非必须 |
Path: /admin/employee
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 非必须 | 员工id | format: int64 | |
idNumber | string | 必须 | 身份证 | ||
name | string | 必须 | 姓名 | ||
phone | string | 必须 | 手机号 | ||
sex | string | 必须 | 性别 | ||
username | string | 必须 | 用户名 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/employee/{id}
+Method: GET
+接口描述:
+路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +100 | +员工id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ createTime | string | 非必须 | format: date-time | ||
├─ createUser | integer | 非必须 | format: int64 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ idNumber | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ password | string | 非必须 | |||
├─ phone | string | 非必须 | |||
├─ sex | string | 非必须 | |||
├─ status | integer | 非必须 | format: int32 | ||
├─ updateTime | string | 非必须 | format: date-time | ||
├─ updateUser | integer | 非必须 | format: int64 | ||
├─ username | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/employee
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 必须 | format: int64 | ||
idNumber | string | 必须 | |||
name | string | 必须 | |||
phone | string | 必须 | |||
sex | string | 必须 | |||
username | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/employee/logout
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/setmeal
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
categoryId | integer | 必须 | 分类id | format: int64 | |
description | string | 非必须 | 套餐描述 | ||
id | integer | 必须 | 套餐id | format: int64 | |
image | string | 必须 | 套餐图片路径 | ||
name | string | 必须 | 套餐名称 | ||
price | number | 必须 | 套餐价格 | ||
setmealDishes | object [] | 必须 | 套餐和菜品关联关系 | item 类型: object | |
├─ copies | integer | 必须 | 菜品份数 | format: int32 | |
├─ dishId | integer | 必须 | 菜品id | format: int64 | |
├─ id | integer | 非必须 | 关系表主键值 | format: int64 | |
├─ name | string | 必须 | 菜品名称 | ||
├─ price | number | 必须 | 菜品价格 | ||
├─ setmealId | integer | 非必须 | 套餐id | format: int64 | |
status | integer | 非必须 | 套餐起售状态 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
msg | string | 非必须 |
Path: /admin/setmeal/page
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
categoryId | +否 | ++ | 分类id | +
name | +否 | ++ | 套餐名称 | +
page | +是 | ++ | 页码 | +
pageSize | +是 | ++ | 每页记录数 | +
status | +否 | ++ | 套餐起售状态 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 必须 | |||
msg | null | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ records | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ categoryId | number | 必须 | |||
├─ name | string | 必须 | |||
├─ price | number | 必须 | |||
├─ status | number | 必须 | |||
├─ description | string | 必须 | |||
├─ image | string | 必须 | |||
├─ updateTime | string | 必须 | |||
├─ categoryName | string | 必须 |
Path: /admin/setmeal/status/{status}
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
status | +1 | +套餐状态,1表示起售,0表示停售 | +
Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
id | +是 | +101 | +套餐id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/setmeal
+Method: DELETE
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
ids | +是 | ++ | ids | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 非必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/setmeal
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
categoryId | integer | 必须 | 分类id | format: int64 | |
description | string | 非必须 | 套餐描述 | ||
id | integer | 非必须 | 套餐id | format: int64 | |
image | string | 必须 | 套餐图片 | ||
name | string | 必须 | 套餐名称 | ||
price | number | 必须 | 套餐价格 | ||
setmealDishes | object [] | 必须 | 套餐包含的菜品 | item 类型: object | |
├─ copies | integer | 必须 | 份数 | format: int32 | |
├─ dishId | integer | 必须 | 菜品id | format: int64 | |
├─ id | integer | 非必须 | 套餐和菜品关系id | format: int64 | |
├─ name | string | 必须 | 菜品名称 | ||
├─ price | number | 必须 | 菜品价格 | ||
├─ setmealId | integer | 必须 | 套餐id | format: int64 | |
status | integer | 必须 | 套餐状态:1位起售 0为停售 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/setmeal/{id}
+Method: GET
+接口描述:
+路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +101 | +套餐id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ categoryId | integer | 必须 | format: int64 | ||
├─ categoryName | string | 必须 | |||
├─ description | string | 必须 | |||
├─ id | integer | 必须 | format: int64 | ||
├─ image | string | 必须 | |||
├─ name | string | 必须 | |||
├─ price | number | 必须 | |||
├─ setmealDishes | object [] | 必须 | item 类型: object | ||
├─ copies | integer | 必须 | format: int32 | ||
├─ dishId | integer | 必须 | format: int64 | ||
├─ id | integer | 必须 | format: int64 | ||
├─ name | string | 必须 | |||
├─ price | number | 必须 | |||
├─ setmealId | integer | 必须 | format: int64 | ||
├─ status | integer | 必须 | format: int32 | ||
├─ updateTime | string | 必须 | format: date-time | ||
msg | string | 非必须 |
Path: /admin/workspace/businessData
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ newUsers | integer | 必须 | 新增用户数 | format: int32 | |
├─ orderCompletionRate | number | 必须 | 订单完成率 | format: double | |
├─ turnover | number | 必须 | 营业额 | format: double | |
├─ unitPrice | number | 必须 | 平均客单价 | format: double | |
├─ validOrderCount | integer | 必须 | 有效订单数 | format: int32 | |
msg | string | 非必须 |
Path: /admin/workspace/overviewSetmeals
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ discontinued | integer | 必须 | 已停售套餐数量 | format: int32 | |
├─ sold | integer | 必须 | 已启售套餐数量 | format: int32 | |
msg | string | 非必须 |
Path: /admin/workspace/overviewDishes
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ discontinued | integer | 必须 | 已停售菜品数量 | format: int32 | |
├─ sold | integer | 必须 | 已启售菜品数量 | format: int32 | |
msg | string | 非必须 |
Path: /admin/workspace/overviewOrders
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ allOrders | integer | 必须 | 全部订单 | format: int32 | |
├─ cancelledOrders | integer | 必须 | 已取消数量 | format: int32 | |
├─ completedOrders | integer | 必须 | 已完成数量 | format: int32 | |
├─ deliveredOrders | integer | 必须 | 待派送数量 | format: int32 | |
├─ waitingOrders | integer | 必须 | 待接单数量 | format: int32 | |
msg | string | 非必须 |
Path: /admin/shop/status
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | integer | 必须 | 店铺营业状态:1为营业,0为打烊 | format: int32 | |
msg | string | 非必须 |
Path: /admin/shop/{status}
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
status | +1 | +店铺营业状态:1为营业,0为打烊 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/report/export
+Method: GET
+接口描述:
+OK
+
+Path: /admin/report/top10
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
begin | +是 | +2022-05-01 | +开始日期 | +
end | +是 | +2022-05-31 | +结束日期 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ nameList | string | 必须 | 商品名称列表,以逗号分隔 | ||
├─ numberList | string | 必须 | 销量列表,以逗号分隔 | ||
msg | string | 非必须 |
Path: /admin/report/userStatistics
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
begin | +是 | +2022-05-01 | +开始日期 | +
end | +是 | +2022-05-31 | +结束日期 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ dateList | string | 必须 | 日期列表,以逗号分隔 | ||
├─ newUserList | string | 必须 | 新增用户数列表,以逗号分隔 | ||
├─ totalUserList | string | 必须 | 总用户量列表,以逗号分隔 | ||
msg | string | 非必须 |
Path: /admin/report/turnoverStatistics
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
begin | +是 | +2022-05-01 | +开始日期 | +
end | +是 | +2022-05-31 | +结束日期 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ dateList | string | 必须 | 日期列表,日期之间以逗号分隔 | ||
├─ turnoverList | string | 必须 | 营业额列表,营业额之间以逗号分隔 | ||
msg | string | 非必须 |
Path: /admin/report/ordersStatistics
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
begin | +是 | +2022-05-01 | +开始日期 | +
end | +是 | +2022-05-31 | +结束日期 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ dateList | string | 必须 | 日期列表,以逗号分隔 | ||
├─ orderCompletionRate | number | 必须 | 订单完成率 | format: double | |
├─ orderCountList | string | 必须 | 订单数列表,以逗号分隔 | ||
├─ totalOrderCount | integer | 必须 | 订单总数 | format: int32 | |
├─ validOrderCount | integer | 必须 | 有效订单数 | format: int32 | |
├─ validOrderCountList | string | 必须 | 有效订单数列表,以逗号分隔 | ||
msg | string | 非必须 |
Path: /admin/dish
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
categoryId | integer | 必须 | format: int64 | ||
description | string | 非必须 | |||
flavors | object [] | 非必须 | item 类型: object | ||
├─ dishId | integer | 非必须 | format: int64 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ name | string | 必须 | |||
├─ value | string | 必须 | |||
id | integer | 必须 | format: int64 | ||
image | string | 必须 | |||
name | string | 必须 | |||
price | number | 必须 | |||
status | integer | 非必须 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/dish
+Method: DELETE
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
ids | +是 | +1,2,3 | +菜品id,之间用逗号分隔 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/dish
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
categoryId | integer | 必须 | 分类id | format: int64 | |
description | string | 非必须 | 菜品描述 | ||
flavors | object [] | 非必须 | 口味 | item 类型: object | |
├─ dishId | integer | 非必须 | 菜品id | format: int64 | |
├─ id | integer | 非必须 | 口味id | format: int64 | |
├─ name | string | 必须 | 口味名称 | ||
├─ value | string | 必须 | 口味值 | ||
id | integer | 非必须 | 菜品id | format: int64 | |
image | string | 必须 | 菜品图片路径 | ||
name | string | 必须 | 菜品名称 | ||
price | number | 必须 | 菜品价格 | ||
status | integer | 非必须 | 菜品状态:1为起售,0为停售 | format: int32 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/dish/{id}
+Method: GET
+接口描述:
+路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +101 | +菜品id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ categoryId | integer | 必须 | format: int64 | ||
├─ categoryName | string | 必须 | |||
├─ description | string | 必须 | |||
├─ flavors | object [] | 必须 | item 类型: object | ||
├─ dishId | integer | 必须 | format: int64 | ||
├─ id | integer | 必须 | format: int64 | ||
├─ name | string | 必须 | |||
├─ value | string | 必须 | |||
├─ id | integer | 必须 | format: int64 | ||
├─ image | string | 必须 | |||
├─ name | string | 必须 | |||
├─ price | number | 必须 | |||
├─ status | integer | 必须 | format: int32 | ||
├─ updateTime | string | 必须 | format: date-time | ||
msg | string | 非必须 |
Path: /admin/dish/list
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
categoryId | +是 | +101 | +分类id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object [] | 非必须 | item 类型: object | ||
├─ categoryId | integer | 非必须 | format: int64 | ||
├─ createTime | string | 非必须 | format: date-time | ||
├─ createUser | integer | 非必须 | format: int64 | ||
├─ description | string | 非必须 | |||
├─ id | integer | 非必须 | format: int64 | ||
├─ image | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ price | number | 非必须 | |||
├─ status | integer | 非必须 | format: int32 | ||
├─ updateTime | string | 非必须 | format: date-time | ||
├─ updateUser | integer | 非必须 | format: int64 | ||
msg | string | 非必须 |
Path: /admin/dish/page
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
categoryId | +否 | +101 | +分类id | +
name | +否 | +宫保鸡丁 | +菜品名称 | +
page | +是 | +1 | +页码 | +
pageSize | +是 | +10 | +每页记录数 | +
status | +否 | +1 | +分类状态 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 必须 | |||
msg | null | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 必须 | 总记录数 | ||
├─ records | object [] | 必须 | 当前页数据 | item 类型: object | |
├─ id | number | 必须 | |||
├─ name | string | 必须 | |||
├─ categoryId | number | 必须 | |||
├─ price | number | 必须 | |||
├─ image | string | 必须 | |||
├─ description | string | 必须 | |||
├─ status | number | 必须 | |||
├─ updateTime | string | 必须 | |||
├─ categoryName | string | 必须 | 分类名称 |
Path: /admin/dish/status/{status}
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
status | +1 | +菜品状态:1为起售,0为停售 | +
Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
id | +是 | +101 | +菜品id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/cancel
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
cancelReason | string | 必须 | 订单取消原因 | ||
id | integer | 必须 | 订单id | format: int64 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/statistics
+Method: GET
+接口描述:
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 必须 | |||
├─ confirmed | integer | 必须 | 待派送数量 | format: int32 | |
├─ deliveryInProgress | integer | 必须 | 派送中数量 | format: int32 | |
├─ toBeConfirmed | integer | 必须 | 待接单数量 | format: int32 | |
msg | string | 非必须 |
Path: /admin/order/complete/{id}
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +101 | +订单id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/rejection
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 必须 | 订单id | format: int64 | |
rejectionReason | string | 必须 | 拒单原因 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/confirm
+Method: PUT
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +application/json | +是 | ++ | + |
Body
+名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
id | integer | 必须 | 订单id | format: int64 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/details/{id}
+Method: GET
+接口描述:
+路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +101 | +订单id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
├─ address | string | 非必须 | |||
├─ addressBookId | integer | 非必须 | format: int64 | ||
├─ amount | number | 非必须 | |||
├─ cancelReason | string | 非必须 | |||
├─ cancelTime | string | 非必须 | format: date-time | ||
├─ checkoutTime | string | 非必须 | format: date-time | ||
├─ consignee | string | 非必须 | |||
├─ deliveryStatus | integer | 非必须 | format: int32 | ||
├─ deliveryTime | string | 非必须 | format: date-time | ||
├─ estimatedDeliveryTime | string | 非必须 | format: date-time | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ number | string | 非必须 | |||
├─ orderDetailList | object [] | 非必须 | item 类型: object | ||
├─ amount | number | 非必须 | |||
├─ dishFlavor | string | 非必须 | |||
├─ dishId | integer | 非必须 | format: int64 | ||
├─ id | integer | 非必须 | format: int64 | ||
├─ image | string | 非必须 | |||
├─ name | string | 非必须 | |||
├─ number | integer | 非必须 | format: int32 | ||
├─ orderId | integer | 非必须 | format: int64 | ||
├─ setmealId | integer | 非必须 | format: int64 | ||
├─ orderDishes | string | 非必须 | |||
├─ orderTime | string | 非必须 | format: date-time | ||
├─ packAmount | integer | 非必须 | format: int32 | ||
├─ payMethod | integer | 非必须 | format: int32 | ||
├─ payStatus | integer | 非必须 | format: int32 | ||
├─ phone | string | 非必须 | |||
├─ rejectionReason | string | 非必须 | |||
├─ remark | string | 非必须 | |||
├─ status | integer | 非必须 | format: int32 | ||
├─ tablewareNumber | integer | 非必须 | format: int32 | ||
├─ tablewareStatus | integer | 非必须 | format: int32 | ||
├─ userId | integer | 非必须 | format: int64 | ||
├─ userName | string | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/delivery/{id}
+Method: PUT
+接口描述:
+路径参数
+参数名称 | +示例 | +备注 | +
---|---|---|
id | +101 | +订单id | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | object | 非必须 | |||
msg | string | 非必须 |
Path: /admin/order/conditionSearch
+Method: GET
+接口描述:
+Query
+参数名称 | +是否必须 | +示例 | +备注 | +
---|---|---|---|
beginTime | +否 | ++ | beginTime | +
endTime | +否 | ++ | endTime | +
number | +否 | ++ | number | +
page | +是 | ++ | page | +
pageSize | +是 | ++ | pageSize | +
phone | +否 | ++ | phone | +
status | +否 | ++ | status | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 必须 | |||
msg | null | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ records | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ number | string | 必须 | |||
├─ status | number | 必须 | |||
├─ userId | number | 必须 | |||
├─ addressBookId | number | 必须 | |||
├─ orderTime | string | 必须 | |||
├─ checkoutTime | null,string | 必须 | |||
├─ payMethod | number | 必须 | |||
├─ payStatus | number | 必须 | |||
├─ amount | number | 必须 | |||
├─ remark | string | 必须 | |||
├─ userName | string | 必须 | |||
├─ phone | string | 必须 | |||
├─ address | string | 必须 | |||
├─ consignee | string | 必须 | |||
├─ cancelReason | string | 必须 | |||
├─ rejectionReason | string | 必须 | |||
├─ cancelTime | string | 必须 | |||
├─ estimatedDeliveryTime | string | 必须 | |||
├─ deliveryStatus | number | 必须 | |||
├─ deliveryTime | string | 必须 | |||
├─ packAmount | number | 必须 | |||
├─ tablewareNumber | number | 必须 | |||
├─ tablewareStatus | number | 必须 | |||
├─ orderDishes | string | 必须 | 订单包含的菜品,以字符串形式展示 |
Path: /admin/common/upload
+Method: POST
+接口描述:
+Headers
+参数名称 | +参数值 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
Content-Type | +multipart/form-data | +是 | ++ | + |
Body
+参数名称 | +参数类型 | +是否必须 | +示例 | +备注 | +
---|---|---|---|---|
file | +file | +是 | ++ | 文件 | +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | integer | 必须 | format: int32 | ||
data | string | 必须 | 文件上传路径 | ||
msg | string | 非必须 |