浏览代码

用户端swagger添加

huangyan 11 月之前
父节点
当前提交
f1fc7da00e

+ 63 - 4
docs/docs.go

@@ -594,7 +594,7 @@ const docTemplate = `{
                         "in": "body",
                         "required": true,
                         "schema": {
-                            "$ref": "#/definitions/myselfsrv.OrderPageReqVO"
+                            "$ref": "#/definitions/swagger.OrderPageReqVO"
                         }
                     }
                 ],
@@ -1004,6 +1004,36 @@ const docTemplate = `{
                 }
             }
         },
+        "constant.SearchDateTimeType": {
+            "type": "string",
+            "enum": [
+                "today",
+                "yesterday",
+                "thisWeek",
+                "thisMonth",
+                "lastThreeDays",
+                "lastSevenDays",
+                "lastMonthDays"
+            ],
+            "x-enum-comments": {
+                "LastMonthDays": "近一个月",
+                "LastSevenDays": "近七天",
+                "LastThreeDays": "近三天",
+                "ThisMonth": "本月",
+                "ThisWeek": "本周",
+                "Today": "今天",
+                "Yesterday": "昨天"
+            },
+            "x-enum-varnames": [
+                "Today",
+                "Yesterday",
+                "ThisWeek",
+                "ThisMonth",
+                "LastThreeDays",
+                "LastSevenDays",
+                "LastMonthDays"
+            ]
+        },
         "devicesrv.DeviceSensorListReqVO": {
             "type": "object",
             "properties": {
@@ -1184,9 +1214,6 @@ const docTemplate = `{
                 }
             }
         },
-        "myselfsrv.OrderPageReqVO": {
-            "type": "object"
-        },
         "myselfsrv.OrderSubNoReqVO": {
             "type": "object",
             "properties": {
@@ -1730,6 +1757,38 @@ const docTemplate = `{
                 }
             }
         },
+        "swagger.OrderPageReqVO": {
+            "type": "object",
+            "properties": {
+                "page": {
+                    "$ref": "#/definitions/swagger.Page"
+                },
+                "search": {
+                    "type": "object",
+                    "properties": {
+                        "orderNo": {
+                            "description": "订单号",
+                            "type": "string"
+                        },
+                        "orderStatus": {
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "placeOrderEndTime": {
+                            "$ref": "#/definitions/models.MyTime"
+                        },
+                        "placeOrderStartTime": {
+                            "$ref": "#/definitions/models.MyTime"
+                        },
+                        "searchDateTime": {
+                            "$ref": "#/definitions/constant.SearchDateTimeType"
+                        }
+                    }
+                }
+            }
+        },
         "swagger.Page": {
             "type": "object",
             "properties": {

+ 63 - 4
docs/swagger.json

@@ -583,7 +583,7 @@
                         "in": "body",
                         "required": true,
                         "schema": {
-                            "$ref": "#/definitions/myselfsrv.OrderPageReqVO"
+                            "$ref": "#/definitions/swagger.OrderPageReqVO"
                         }
                     }
                 ],
@@ -993,6 +993,36 @@
                 }
             }
         },
+        "constant.SearchDateTimeType": {
+            "type": "string",
+            "enum": [
+                "today",
+                "yesterday",
+                "thisWeek",
+                "thisMonth",
+                "lastThreeDays",
+                "lastSevenDays",
+                "lastMonthDays"
+            ],
+            "x-enum-comments": {
+                "LastMonthDays": "近一个月",
+                "LastSevenDays": "近七天",
+                "LastThreeDays": "近三天",
+                "ThisMonth": "本月",
+                "ThisWeek": "本周",
+                "Today": "今天",
+                "Yesterday": "昨天"
+            },
+            "x-enum-varnames": [
+                "Today",
+                "Yesterday",
+                "ThisWeek",
+                "ThisMonth",
+                "LastThreeDays",
+                "LastSevenDays",
+                "LastMonthDays"
+            ]
+        },
         "devicesrv.DeviceSensorListReqVO": {
             "type": "object",
             "properties": {
@@ -1173,9 +1203,6 @@
                 }
             }
         },
-        "myselfsrv.OrderPageReqVO": {
-            "type": "object"
-        },
         "myselfsrv.OrderSubNoReqVO": {
             "type": "object",
             "properties": {
@@ -1719,6 +1746,38 @@
                 }
             }
         },
+        "swagger.OrderPageReqVO": {
+            "type": "object",
+            "properties": {
+                "page": {
+                    "$ref": "#/definitions/swagger.Page"
+                },
+                "search": {
+                    "type": "object",
+                    "properties": {
+                        "orderNo": {
+                            "description": "订单号",
+                            "type": "string"
+                        },
+                        "orderStatus": {
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            }
+                        },
+                        "placeOrderEndTime": {
+                            "$ref": "#/definitions/models.MyTime"
+                        },
+                        "placeOrderStartTime": {
+                            "$ref": "#/definitions/models.MyTime"
+                        },
+                        "searchDateTime": {
+                            "$ref": "#/definitions/constant.SearchDateTimeType"
+                        }
+                    }
+                }
+            }
+        },
         "swagger.Page": {
             "type": "object",
             "properties": {

+ 48 - 3
docs/swagger.yaml

@@ -36,6 +36,32 @@ definitions:
       parentId:
         type: integer
     type: object
+  constant.SearchDateTimeType:
+    enum:
+    - today
+    - yesterday
+    - thisWeek
+    - thisMonth
+    - lastThreeDays
+    - lastSevenDays
+    - lastMonthDays
+    type: string
+    x-enum-comments:
+      LastMonthDays: 近一个月
+      LastSevenDays: 近七天
+      LastThreeDays: 近三天
+      ThisMonth: 本月
+      ThisWeek: 本周
+      Today: 今天
+      Yesterday: 昨天
+    x-enum-varnames:
+    - Today
+    - Yesterday
+    - ThisWeek
+    - ThisMonth
+    - LastThreeDays
+    - LastSevenDays
+    - LastMonthDays
   devicesrv.DeviceSensorListReqVO:
     properties:
       snCode:
@@ -155,8 +181,6 @@ definitions:
       logisticId:
         type: integer
     type: object
-  myselfsrv.OrderPageReqVO:
-    type: object
   myselfsrv.OrderSubNoReqVO:
     properties:
       orderId:
@@ -520,6 +544,27 @@ definitions:
       page:
         $ref: '#/definitions/swagger.Page'
     type: object
+  swagger.OrderPageReqVO:
+    properties:
+      page:
+        $ref: '#/definitions/swagger.Page'
+      search:
+        properties:
+          orderNo:
+            description: 订单号
+            type: string
+          orderStatus:
+            items:
+              type: integer
+            type: array
+          placeOrderEndTime:
+            $ref: '#/definitions/models.MyTime'
+          placeOrderStartTime:
+            $ref: '#/definitions/models.MyTime'
+          searchDateTime:
+            $ref: '#/definitions/constant.SearchDateTimeType'
+        type: object
+    type: object
   swagger.Page:
     properties:
       offset:
@@ -988,7 +1033,7 @@ paths:
         name: req
         required: true
         schema:
-          $ref: '#/definitions/myselfsrv.OrderPageReqVO'
+          $ref: '#/definitions/swagger.OrderPageReqVO'
       responses:
         "200":
           description: 成功响应的结构体

+ 1 - 1
internal/server/adapter/http/v1/myself/order.go

@@ -16,7 +16,7 @@ import (
 // @BasePath /clodLogistic/app/api/v1
 // @Summary 订单列表
 // @Success 200 {object}  swagger.PageListResponse "成功响应的结构体"
-// @Param  req body myselfsrv.OrderPageReqVO true "请求参数"
+// @Param  req body swagger.OrderPageReqVO true "请求参数"
 // @Accept application/json
 // @Authorization
 // @Router /myself/orderPage [post]

+ 11 - 0
internal/server/adapter/http/v1/swagger/swagger_model.go

@@ -1,6 +1,7 @@
 package swagger
 
 import (
+	"Cold_Logistic/internal/pkg/common/constant"
 	"Cold_Logistic/internal/server/infra/models"
 )
 
@@ -19,6 +20,16 @@ type LogisticListReqVO struct {
 		Name string `json:"name"`
 	}
 }
+type OrderPageReqVO struct {
+	Page   Page `json:"page"`
+	Search struct {
+		OrderNo             string                      `json:"orderNo"` // 订单号
+		OrderStatus         []int                       `json:"orderStatus"`
+		SearchDateTime      constant.SearchDateTimeType `json:"searchDateTime"`
+		PlaceOrderStartTime models.MyTime               `json:"placeOrderStartTime"`
+		PlaceOrderEndTime   models.MyTime               `json:"placeOrderEndTime"`
+	}
+}
 type WarehouseOrderReqVO struct {
 	Page   Page `json:"page"`
 	Search struct {