diff --git a/controller/login.go b/controller/login.go index 9bb2bdb..5ac92a3 100644 --- a/controller/login.go +++ b/controller/login.go @@ -8,9 +8,10 @@ import ( ) // @Summary 登陆验证接口 // @Produce json -// @Param username query string true "username" -// @Param password query string true "password" -// @Param type query string true "type" +// @Accept multipart/form-data +// @Param username formData string true "username" +// @Param password formData string true "password" +// @Param type formData string true "type" // @Success 200 {string} string "{"code":200,"result":{},"msg":"ok"}" // @Router /check [post] //验证接口 diff --git a/docs/docs.go b/docs/docs.go index e4ffd7b..c2cbbce 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1,6 +1,6 @@ // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT // This file was generated by swaggo/swag at -// 2020-07-10 21:47:01.2609898 +0800 CST m=+0.152892201 +// 2020-07-10 22:43:52.8548363 +0800 CST m=+0.306823701 package docs @@ -28,6 +28,9 @@ var doc = `{ "paths": { "/check": { "post": { + "consumes": [ + "multipart/form-data" + ], "produces": [ "application/json" ], @@ -37,21 +40,21 @@ var doc = `{ "type": "string", "description": "username", "name": "username", - "in": "query", + "in": "formData", "required": true }, { "type": "string", "description": "password", "name": "password", - "in": "query", + "in": "formData", "required": true }, { "type": "string", "description": "type", "name": "type", - "in": "query", + "in": "formData", "required": true } ], diff --git a/docs/swagger.json b/docs/swagger.json index d488bcb..9c05645 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -7,6 +7,9 @@ "paths": { "/check": { "post": { + "consumes": [ + "multipart/form-data" + ], "produces": [ "application/json" ], @@ -16,21 +19,21 @@ "type": "string", "description": "username", "name": "username", - "in": "query", + "in": "formData", "required": true }, { "type": "string", "description": "password", "name": "password", - "in": "query", + "in": "formData", "required": true }, { "type": "string", "description": "type", "name": "type", - "in": "query", + "in": "formData", "required": true } ], diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 3bd6247..91794c8 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -4,19 +4,21 @@ info: paths: /check: post: + consumes: + - multipart/form-data parameters: - description: username - in: query + in: formData name: username required: true type: string - description: password - in: query + in: formData name: password required: true type: string - description: type - in: query + in: formData name: type required: true type: string diff --git a/readme.md b/readme.md index 043283a..f363550 100644 --- a/readme.md +++ b/readme.md @@ -57,9 +57,9 @@ ``` -3. 源码运行 go run server.go +3. 源码运行 go run main.go -4. 源码打包 go build server.go +4. 源码打包 go build main.go ### nginx部署 @@ -80,3 +80,8 @@ server { } } ``` + +### 生成文档 + +1. 需要先安装swag +2. 在根目录swag init