feat: base: upgrade swagger

docs/docs.go

@@ -2,16 +2,9 @@
 // This file was generated by swaggo/swag
 package docs
 
-import (
+import "github.com/swaggo/swag"
-	"bytes"
-	"encoding/json"
-	"strings"
-	"text/template"
 
-	"github.com/swaggo/swag"
+const docTemplate_swagger = `{
-)
-
-var doc = `{
     "schemes": {{ marshal .Schemes }},
     "swagger": "2.0",
     "info": {
@@ -25,6 +18,9 @@ var doc = `{
     "paths": {
         "/statistics/china": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -53,6 +49,9 @@ var doc = `{
         },
         "/statistics/city/{sort}": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -98,6 +97,9 @@ var doc = `{
         },
         "/statistics/country": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -129,6 +131,9 @@ var doc = `{
         },
         "/statistics/country/child": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -158,12 +163,15 @@ var doc = `{
                 }
             }
         },
-        "/statistics/provience/{sort}": {
+        "/statistics/province/{sort}": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
-                "summary": "provience statistics",
+                "summary": "province statistics",
                 "parameters": [
                     {
                         "enum": [
@@ -374,56 +382,18 @@ var doc = `{
     }
 }`
 
-type swaggerInfo struct {
+// SwaggerInfo_swagger holds exported Swagger Info so clients can modify it
-	Version     string
+var SwaggerInfo_swagger = &swag.Spec{
-	Host        string
+	Version:          "1.0",
-	BasePath    string
+	Host:             "",
-	Schemes     []string
+	BasePath:         "",
-	Title       string
+	Schemes:          []string{},
-	Description string
+	Title:            "nCov Tracker",
-}
+	Description:      "",
-
+	InfoInstanceName: "swagger",
-// SwaggerInfo holds exported Swagger Info so clients can modify it
+	SwaggerTemplate:  docTemplate_swagger,
-var SwaggerInfo = swaggerInfo{
-	Version:     "1.0",
-	Host:        "",
-	BasePath:    "",
-	Schemes:     []string{},
-	Title:       "nCov Tracker",
-	Description: "",
-}
-
-type s struct{}
-
-func (s *s) ReadDoc() string {
-	sInfo := SwaggerInfo
-	sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
-
-	t, err := template.New("swagger_info").Funcs(template.FuncMap{
-		"marshal": func(v interface{}) string {
-			a, _ := json.Marshal(v)
-			return string(a)
-		},
-		"escape": func(v interface{}) string {
-			// escape tabs
-			str := strings.Replace(v.(string), "\t", "\\t", -1)
-			// replace " with \", and if that results in \\", replace that with \\\"
-			str = strings.Replace(str, "\"", "\\\"", -1)
-			return strings.Replace(str, "\\\\\"", "\\\\\\\"", -1)
-		},
-	}).Parse(doc)
-	if err != nil {
-		return doc
-	}
-
-	var tpl bytes.Buffer
-	if err := t.Execute(&tpl, sInfo); err != nil {
-		return doc
-	}
-
-	return tpl.String()
 }
 
 func init() {
-	swag.Register("swagger", &s{})
+	swag.Register(SwaggerInfo_swagger.InstanceName(), SwaggerInfo_swagger)
 }

docs/swagger.json

@@ -8,6 +8,9 @@
     "paths": {
         "/statistics/china": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -36,6 +39,9 @@
         },
         "/statistics/city/{sort}": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -81,6 +87,9 @@
         },
         "/statistics/country": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -112,6 +121,9 @@
         },
         "/statistics/country/child": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
@@ -141,12 +153,15 @@
                 }
             }
         },
-        "/statistics/provience/{sort}": {
+        "/statistics/province/{sort}": {
             "get": {
+                "produces": [
+                    "application/json"
+                ],
                 "tags": [
                     "Statistics"
                 ],
-                "summary": "provience statistics",
+                "summary": "province statistics",
                 "parameters": [
                     {
                         "enum": [

docs/swagger.yaml

@@ -115,6 +115,8 @@ info:
 paths:
   /statistics/china:
     get:
+      produces:
+      - application/json
       responses:
         "200":
           description: OK
@@ -140,6 +142,8 @@ paths:
         in: path
         name: sort
         type: string
+      produces:
+      - application/json
       responses:
         "200":
           description: OK
@@ -157,6 +161,8 @@ paths:
       - Statistics
   /statistics/country:
     get:
+      produces:
+      - application/json
       responses:
         "200":
           description: OK
@@ -174,6 +180,8 @@ paths:
       - Statistics
   /statistics/country/child:
     get:
+      produces:
+      - application/json
       responses:
         "200":
           description: OK
@@ -189,7 +197,7 @@ paths:
       summary: country statistics
       tags:
       - Statistics
-  /statistics/provience/{sort}:
+  /statistics/province/{sort}:
     get:
       parameters:
       - description: data sorted by
@@ -201,6 +209,8 @@ paths:
         in: path
         name: sort
         type: string
+      produces:
+      - application/json
       responses:
         "200":
           description: OK
@@ -213,7 +223,7 @@ paths:
                     $ref: '#/definitions/models.AreaInfo'
                   type: array
               type: object
-      summary: provience statistics
+      summary: province statistics
       tags:
       - Statistics
 swagger: "2.0"

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/go-redis/redis v6.15.9+incompatible
 	github.com/robfig/cron/v3 v3.0.1
 	github.com/spf13/viper v1.10.1
-	github.com/swaggo/swag v1.7.8
+	github.com/swaggo/swag v1.7.9
 	go.uber.org/zap v1.20.0
 	gorm.io/driver/mysql v1.2.3
 	gorm.io/gorm v1.22.4
@@ -23,7 +23,7 @@ require (
 	github.com/go-openapi/jsonpointer v0.19.5 // indirect
 	github.com/go-openapi/jsonreference v0.19.6 // indirect
 	github.com/go-openapi/spec v0.20.4 // indirect
-	github.com/go-openapi/swag v0.19.15 // indirect
+	github.com/go-openapi/swag v0.21.1 // indirect
 	github.com/go-playground/locales v0.14.0 // indirect
 	github.com/go-playground/universal-translator v0.18.0 // indirect
 	github.com/go-playground/validator/v10 v10.10.0 // indirect
@@ -57,10 +57,10 @@ require (
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/multierr v1.7.0 // indirect
 	golang.org/x/crypto v0.0.0-20220112180741-5e0467b6c7ce // indirect
-	golang.org/x/net v0.0.0-20220121210141-e204ce36a2ba // indirect
+	golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
-	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
+	golang.org/x/sys v0.0.0-20220209214540-3681064d5158 // indirect
 	golang.org/x/text v0.3.7 // indirect
-	golang.org/x/tools v0.1.8 // indirect
+	golang.org/x/tools v0.1.9 // indirect
 	google.golang.org/protobuf v1.27.1 // indirect
 	gopkg.in/ini.v1 v1.66.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -93,6 +93,8 @@ github.com/go-openapi/spec v0.20.4/go.mod h1:faYFR1CvsJZ0mNsmsphTMSoRrNV3TEDoAM7
 github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk=
 github.com/go-openapi/swag v0.19.15 h1:D2NRCBzS9/pEY3gP9Nl8aDqGUcPFrwG2p+CNFrLyrCM=
 github.com/go-openapi/swag v0.19.15/go.mod h1:QYRuS/SOXUCsnplDa677K7+DxSOj6IPNl/eQntq43wQ=
+github.com/go-openapi/swag v0.21.1 h1:wm0rhTb5z7qpJRHBdPOMuY4QjVUMbF6/kwoYeRAOrKU=
+github.com/go-openapi/swag v0.21.1/go.mod h1:QYRuS/SOXUCsnplDa677K7+DxSOj6IPNl/eQntq43wQ=
 github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A=
 github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
 github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8=
@@ -296,6 +298,8 @@ github.com/swaggo/gin-swagger v1.4.0 h1:AV1vlpiYMKUawINGVO5gtmLlGPOOJfxXxAJnxSlA
 github.com/swaggo/gin-swagger v1.4.0/go.mod h1:VAoX17txQZ3i/Qsbd4G/k+boFVSfWsOSSA2YTfgtUlA=
 github.com/swaggo/swag v1.7.8 h1:w249t0l/kc/DKMGlS0fppNJQxKyJ8heNaUWB6nsH3zc=
 github.com/swaggo/swag v1.7.8/go.mod h1:gZ+TJ2w/Ve1RwQsA2IRoSOTidHz6DX+PIG8GWvbnoLU=
+github.com/swaggo/swag v1.7.9 h1:6vCG5mm43ebDzGlZPMGYrYI4zKFfOr5kicQX8qjeDwc=
+github.com/swaggo/swag v1.7.9/go.mod h1:gZ+TJ2w/Ve1RwQsA2IRoSOTidHz6DX+PIG8GWvbnoLU=
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go v1.2.6 h1:tGiWC9HENWE2tqYycIqFTNorMmFRVhNwCpDOpWqnk8E=
 github.com/ugorji/go v1.2.6/go.mod h1:anCg0y61KIhDlPZmnH+so+RQbysYVyDko0IMgJv0Nn0=
@@ -411,6 +415,8 @@ golang.org/x/net v0.0.0-20210428140749-89ef3d95e781/go.mod h1:OJAsFXCWl8Ukc7SiCT
 golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/net v0.0.0-20220121210141-e204ce36a2ba h1:6u6sik+bn/y7vILcYkK3iwTBWN7WtBvB0+SZswQnbf8=
 golang.org/x/net v0.0.0-20220121210141-e204ce36a2ba/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
+golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd h1:O7DYs+zxREGLKzKoMQrtrEacpb0ZVXA5rIwylE2Xchk=
+golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
 golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
@@ -483,6 +489,8 @@ golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e h1:fLOSk5Q00efkSvAm+4xcoXD+R
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 h1:XfKQ4OlFl8okEOr5UvAqFRVj8pY/4yfcXrddB8qAbU0=
 golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220209214540-3681064d5158 h1:rm+CHSpPEEW2IsXUib1ThaHIjuBVZjxNgSKmBLFfD4c=
+golang.org/x/sys v0.0.0-20220209214540-3681064d5158/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -549,6 +557,8 @@ golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo=
 golang.org/x/tools v0.1.8 h1:P1HhGGuLW4aAclzjtmJdf0mJOjVUZUzOTqkAkWL+l6w=
 golang.org/x/tools v0.1.8/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU=
+golang.org/x/tools v0.1.9 h1:j9KsMiaP1c3B0OTQGth0/k+miLGTgLsAFUCrF2vLcF8=
+golang.org/x/tools v0.1.9/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

initialize/swagger.go

@@ -9,6 +9,6 @@ import (
 )
 
 func initSwagger() {
-	docs.SwaggerInfo.BasePath = "/api" + global.ServerSettings.UrlPrefix
+	docs.SwaggerInfo_swagger.BasePath = "/api" + global.ServerSettings.UrlPrefix
 	global.RootRouter.GET("/swagger/*any", swagger.WrapHandler(swaggerFile.Handler))
 }