From 2d911d76bffda47005f8a30eb8f3719316bf43c9 Mon Sep 17 00:00:00 2001
From: zhangqian <zhangqian@123.com>
Date: 星期三, 26 六月 2024 16:29:47 +0800
Subject: [PATCH] update doc
---
docs/swagger.yaml | 113 +++++++++++++
docs/docs.go | 173 +++++++++++++++++++++
docs/swagger.json | 170 ++++++++++++++++++++
3 files changed, 445 insertions(+), 11 deletions(-)
diff --git a/docs/docs.go b/docs/docs.go
index a30715f..4ef8f28 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -1,5 +1,4 @@
-// Code generated by swaggo/swag. DO NOT EDIT.
-
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
@@ -167,7 +166,7 @@
}
},
"/api-wms/v1/attribute/attribute": {
- "post": {
+ "get": {
"produces": [
"application/json"
],
@@ -184,6 +183,41 @@
"schema": {
"$ref": "#/definitions/request.AttributeList"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ },
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "灞炴��"
+ ],
+ "summary": "娣诲姞灞炴��",
+ "parameters": [
+ {
+ "description": "灞炴�т俊鎭�",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/request.AddAttribute"
+ }
+ },
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
}
],
"responses": {
@@ -2356,12 +2390,40 @@
"tags": [
"浜у搧"
],
- "summary": "鍒犻櫎浜у搧",
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鍒犻櫎浜у搧",
"parameters": [
{
"type": "string",
"description": "id",
"name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/deleteProductByBarCode/{barCode}": {
+ "delete": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮佸垹闄や骇鍝�",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "barCode",
+ "name": "barCode",
"in": "path",
"required": true
}
@@ -2525,12 +2587,66 @@
"tags": [
"浜у搧"
],
- "summary": "鑾峰彇浜у搧璇︽儏",
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鑾峰彇浜у搧璇︽儏",
"parameters": [
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ },
{
"type": "string",
"description": "id",
"name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/util.Response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/models.Material"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/getProductDetailsByBarCode/{barCode}": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮� 鑾峰彇浜у搧璇︽儏",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "barCode",
+ "name": "barCode",
"in": "path",
"required": true
}
@@ -2670,6 +2786,9 @@
},
"/api-wms/v1/product/inputProduct": {
"post": {
+ "consumes": [
+ "multipart/form-data"
+ ],
"produces": [
"application/xlsx"
],
@@ -2677,6 +2796,22 @@
"鐗╂枡绠＄悊"
],
"summary": "瀵煎叆鐗╂枡",
+ "parameters": [
+ {
+ "type": "file",
+ "description": "file",
+ "name": "file",
+ "in": "formData",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"description": "鎴愬姛",
@@ -3424,6 +3559,21 @@
"CostingMethodAverageCost"
]
},
+ "constvar.FileTemplateCategory": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2
+ ],
+ "x-enum-comments": {
+ "FileTemplateCategory_Output": "鍑哄簱",
+ "FileTemplateCategory_Selfmade": "鍏ュ簱-鑷埗"
+ },
+ "x-enum-varnames": [
+ "FileTemplateCategory_Selfmade",
+ "FileTemplateCategory_Output"
+ ]
+ },
"constvar.FileType": {
"type": "string",
"enum": [
@@ -4047,6 +4197,10 @@
"autoIncr": {
"type": "integer"
},
+ "barCode": {
+ "description": "鍒涘缓浜�",
+ "type": "string"
+ },
"barcode": {
"description": "鏉＄爜",
"type": "string"
@@ -4587,6 +4741,9 @@
"receiverPhone": {
"type": "string"
},
+ "remark": {
+ "type": "string"
+ },
"salesDetailsNumber": {
"type": "string"
},
@@ -4890,6 +5047,12 @@
"createTime": {
"type": "string"
},
+ "fileTemplateCategoryIn": {
+ "$ref": "#/definitions/constvar.FileTemplateCategory"
+ },
+ "fileTemplateCategoryOut": {
+ "$ref": "#/definitions/constvar.FileTemplateCategory"
+ },
"id": {
"type": "integer"
},
diff --git a/docs/swagger.json b/docs/swagger.json
index e2c314e..ec65698 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -155,7 +155,7 @@
}
},
"/api-wms/v1/attribute/attribute": {
- "post": {
+ "get": {
"produces": [
"application/json"
],
@@ -172,6 +172,41 @@
"schema": {
"$ref": "#/definitions/request.AttributeList"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ },
+ "post": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "灞炴��"
+ ],
+ "summary": "娣诲姞灞炴��",
+ "parameters": [
+ {
+ "description": "灞炴�т俊鎭�",
+ "name": "object",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/request.AddAttribute"
+ }
+ },
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
}
],
"responses": {
@@ -2344,12 +2379,40 @@
"tags": [
"浜у搧"
],
- "summary": "鍒犻櫎浜у搧",
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鍒犻櫎浜у搧",
"parameters": [
{
"type": "string",
"description": "id",
"name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "$ref": "#/definitions/util.Response"
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/deleteProductByBarCode/{barCode}": {
+ "delete": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮佸垹闄や骇鍝�",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "barCode",
+ "name": "barCode",
"in": "path",
"required": true
}
@@ -2513,12 +2576,66 @@
"tags": [
"浜у搧"
],
- "summary": "鑾峰彇浜у搧璇︽儏",
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鑾峰彇浜у搧璇︽儏",
"parameters": [
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ },
{
"type": "string",
"description": "id",
"name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "鎴愬姛",
+ "schema": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/util.Response"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "#/definitions/models.Material"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "/api-wms/v1/product/getProductDetailsByBarCode/{barCode}": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "浜у搧"
+ ],
+ "summary": "閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮� 鑾峰彇浜у搧璇︽儏",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "barCode",
+ "name": "barCode",
"in": "path",
"required": true
}
@@ -2658,6 +2775,9 @@
},
"/api-wms/v1/product/inputProduct": {
"post": {
+ "consumes": [
+ "multipart/form-data"
+ ],
"produces": [
"application/xlsx"
],
@@ -2665,6 +2785,22 @@
"鐗╂枡绠＄悊"
],
"summary": "瀵煎叆鐗╂枡",
+ "parameters": [
+ {
+ "type": "file",
+ "description": "file",
+ "name": "file",
+ "in": "formData",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "token",
+ "name": "Authorization",
+ "in": "header",
+ "required": true
+ }
+ ],
"responses": {
"200": {
"description": "鎴愬姛",
@@ -3412,6 +3548,21 @@
"CostingMethodAverageCost"
]
},
+ "constvar.FileTemplateCategory": {
+ "type": "integer",
+ "enum": [
+ 1,
+ 2
+ ],
+ "x-enum-comments": {
+ "FileTemplateCategory_Output": "鍑哄簱",
+ "FileTemplateCategory_Selfmade": "鍏ュ簱-鑷埗"
+ },
+ "x-enum-varnames": [
+ "FileTemplateCategory_Selfmade",
+ "FileTemplateCategory_Output"
+ ]
+ },
"constvar.FileType": {
"type": "string",
"enum": [
@@ -4035,6 +4186,10 @@
"autoIncr": {
"type": "integer"
},
+ "barCode": {
+ "description": "鍒涘缓浜�",
+ "type": "string"
+ },
"barcode": {
"description": "鏉＄爜",
"type": "string"
@@ -4575,6 +4730,9 @@
"receiverPhone": {
"type": "string"
},
+ "remark": {
+ "type": "string"
+ },
"salesDetailsNumber": {
"type": "string"
},
@@ -4878,6 +5036,12 @@
"createTime": {
"type": "string"
},
+ "fileTemplateCategoryIn": {
+ "$ref": "#/definitions/constvar.FileTemplateCategory"
+ },
+ "fileTemplateCategoryOut": {
+ "$ref": "#/definitions/constvar.FileTemplateCategory"
+ },
"id": {
"type": "integer"
},
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index f99e6fd..d6f01be 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -74,6 +74,17 @@
- CostingMethodStandardPrice
- CostingMethodFIFO
- CostingMethodAverageCost
+ constvar.FileTemplateCategory:
+ enum:
+ - 1
+ - 2
+ type: integer
+ x-enum-comments:
+ FileTemplateCategory_Output: 鍑哄簱
+ FileTemplateCategory_Selfmade: 鍏ュ簱-鑷埗
+ x-enum-varnames:
+ - FileTemplateCategory_Selfmade
+ - FileTemplateCategory_Output
constvar.FileType:
enum:
- file
@@ -540,6 +551,9 @@
type: array
autoIncr:
type: integer
+ barCode:
+ description: 鍒涘缓浜�
+ type: string
barcode:
description: 鏉＄爜
type: string
@@ -926,6 +940,8 @@
type: string
receiverPhone:
type: string
+ remark:
+ type: string
salesDetailsNumber:
type: string
source:
@@ -1127,6 +1143,10 @@
type: string
createTime:
type: string
+ fileTemplateCategoryIn:
+ $ref: '#/definitions/constvar.FileTemplateCategory'
+ fileTemplateCategoryOut:
+ $ref: '#/definitions/constvar.FileTemplateCategory'
id:
type: integer
inboundTransportation:
@@ -2217,7 +2237,7 @@
tags:
- 闄勪欢绠＄悊
/api-wms/v1/attribute/attribute:
- post:
+ get:
parameters:
- description: 灞炴�у�煎拰瀵硅薄淇℃伅
in: body
@@ -2235,6 +2255,29 @@
summary: 娣诲姞灞炴�у�煎拰瀵硅薄
tags:
- 灞炴�у�煎拰瀵硅薄
+ post:
+ parameters:
+ - description: 灞炴�т俊鎭�
+ in: body
+ name: object
+ required: true
+ schema:
+ $ref: '#/definitions/request.AddAttribute'
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/util.Response'
+ summary: 娣诲姞灞炴��
+ tags:
+ - 灞炴��
/api-wms/v1/attribute/delete/{id}:
delete:
parameters:
@@ -3577,7 +3620,25 @@
description: 鎴愬姛
schema:
$ref: '#/definitions/util.Response'
- summary: 鍒犻櫎浜у搧
+ summary: 閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鍒犻櫎浜у搧
+ tags:
+ - 浜у搧
+ /api-wms/v1/product/deleteProductByBarCode/{barCode}:
+ delete:
+ parameters:
+ - description: barCode
+ in: path
+ name: barCode
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ $ref: '#/definitions/util.Response'
+ summary: 閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮佸垹闄や骇鍝�
tags:
- 浜у搧
/api-wms/v1/product/deleteProductCategory/{id}:
@@ -3668,6 +3729,11 @@
/api-wms/v1/product/getProductDetails/{id}:
get:
parameters:
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
- description: id
in: path
name: id
@@ -3685,7 +3751,35 @@
data:
$ref: '#/definitions/models.Material'
type: object
- summary: 鑾峰彇浜у搧璇︽儏
+ summary: 閫氳繃浜у搧/鍟嗗搧/鐗╂枡 ID鑾峰彇浜у搧璇︽儏
+ tags:
+ - 浜у搧
+ /api-wms/v1/product/getProductDetailsByBarCode/{barCode}:
+ get:
+ parameters:
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
+ - description: barCode
+ in: path
+ name: barCode
+ required: true
+ type: string
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: 鎴愬姛
+ schema:
+ allOf:
+ - $ref: '#/definitions/util.Response'
+ - properties:
+ data:
+ $ref: '#/definitions/models.Material'
+ type: object
+ summary: 閫氳繃浜у搧/鍟嗗搧/鐗╂枡 鏉″舰鐮� 鑾峰彇浜у搧璇︽儏
tags:
- 浜у搧
/api-wms/v1/product/getProductList:
@@ -3753,6 +3847,19 @@
- 浜у搧
/api-wms/v1/product/inputProduct:
post:
+ consumes:
+ - multipart/form-data
+ parameters:
+ - description: file
+ in: formData
+ name: file
+ required: true
+ type: file
+ - description: token
+ in: header
+ name: Authorization
+ required: true
+ type: string
produces:
- application/xlsx
responses:
--
Gitblit v1.8.0