fix: swag

Author: Ropon

README.md

@@ -20,6 +20,8 @@ bash new_project.sh testpro 8866
 #### 3、dev
 
 ```shell
+#热加载自动生成swagger文档
+go install github.com/swaggo/swag/cmd/swag@v1.8.12
 cd testpro
 ./air
 ```

controllers/hi.go

@@ -1,11 +1,37 @@
 package controllers
 
 import (
+	"fmt"
 	"github.com/gin-gonic/gin"
 	"github.com/ropon/work_api/utils"
+	"strconv"
 	"time"
 )
 
+func initExtraKeys(c *gin.Context) (string, string) {
+	return c.Request.Header.Get("user_email"), c.Request.Header.Get("ops_admin")
+}
+
+//检查params id
+func checkParamsId(c *gin.Context) (uint, bool) {
+	idStr := c.Param("id")
+	id, err := strconv.Atoi(idStr)
+	if err != nil || id == 0 {
+		utils.GinErrRsp(c, utils.ErrCodeParamInvalid, fmt.Sprintf("传入id[%s]不合法", idStr))
+		return 0, false
+	}
+	return uint(id), true
+}
+
+//检查请求体
+func checkData(c *gin.Context, v interface{}) bool {
+	if err := c.ShouldBind(v); err != nil {
+		utils.GinErrRsp(c, utils.ErrCodeParamInvalid, "参数有误:"+err.Error())
+		return false
+	}
+	return true
+}
+
 func Hi(c *gin.Context) {
 	time.Sleep(time.Second * 10)
 	utils.GinOKRsp(c, "hi ropon", "ok")

controllers/service.go

@@ -1,37 +1,11 @@
 package controllers
 
 import (
-	"fmt"
 	"github.com/gin-gonic/gin"
 	"github.com/ropon/work_api/logics"
 	"github.com/ropon/work_api/utils"
-	"strconv"
 )
 
-func initExtraKeys(c *gin.Context) (string, string) {
-	return c.Request.Header.Get("user_email"), c.Request.Header.Get("ops_admin")
-}
-
-//检查params id
-func checkParamsId(c *gin.Context) (uint, bool) {
-	idStr := c.Param("id")
-	id, err := strconv.Atoi(idStr)
-	if err != nil || id == 0 {
-		utils.GinErrRsp(c, utils.ErrCodeParamInvalid, fmt.Sprintf("传入id[%s]不合法", idStr))
-		return 0, false
-	}
-	return uint(id), true
-}
-
-//检查请求体
-func checkData(c *gin.Context, v interface{}) bool {
-	if err := c.ShouldBind(v); err != nil {
-		utils.GinErrRsp(c, utils.ErrCodeParamInvalid, "参数有误:"+err.Error())
-		return false
-	}
-	return true
-}
-
 // CreateService 创建服务接口
 // @Summary 创建服务接口
 // @Description 创建服务接口

docs/docs.go

@@ -207,7 +207,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": ""
+                        "description": "OK"
                     }
                 }
             },

docs/swagger.json

@@ -167,7 +167,7 @@ paths:
       - application/json
       responses:
         "200":
-          description: ""
+          description: OK
       summary: 删除服务接口
       tags:
       - 服务相关接口

docs/swagger.yaml

@@ -7,22 +7,18 @@ require (
 	github.com/Shopify/sarama v1.30.1
 	github.com/gin-contrib/pprof v1.3.0
 	github.com/gin-gonic/gin v1.7.4
-	github.com/go-openapi/spec v0.20.4 // indirect
 	github.com/go-playground/validator/v10 v10.9.0 // indirect
 	github.com/go-redis/redis v0.0.0-20190803144825-742f3ccb21cd
 	github.com/go-sql-driver/mysql v1.6.1-0.20210825083250-6cf3092b0e12
 	github.com/jinzhu/gorm v1.9.17-0.20210521233931-90f139aba3a6
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-isatty v0.0.13 // indirect
 	github.com/opentracing/opentracing-go v1.2.0
-	github.com/ropon/logger v1.0.1
+	github.com/ropon/logger v1.0.2
 	github.com/swaggo/gin-swagger v1.3.3
-	github.com/swaggo/swag v1.7.6
+	github.com/swaggo/swag v1.16.1
 	github.com/uber/jaeger-client-go v2.30.0+incompatible
 	github.com/uber/jaeger-lib v2.4.1+incompatible // indirect
 	go.etcd.io/etcd/client/v3 v3.5.1
-	golang.org/x/net v0.0.0-20211216030914-fe4d6282115f // indirect
-	golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e // indirect
-	golang.org/x/tools v0.1.8 // indirect
 	google.golang.org/protobuf v1.27.1 // indirect
 )