{"id":508,"date":"2024-05-26T23:53:02","date_gmt":"2024-05-26T15:53:02","guid":{"rendered":"http:\/\/moyisuiying.com\/?p=508"},"modified":"2024-05-27T00:00:43","modified_gmt":"2024-05-26T16:00:43","slug":"go-swagger%e4%bd%bf%e7%94%a8%e7%ae%80%e4%bb%8b%e4%bb%a5%e5%8f%8ahertz%e6%a1%86%e6%9e%b6%e4%b8%ad%e9%9b%86%e6%88%90go-swagger","status":"publish","type":"post","link":"http:\/\/moyisuiying.com\/index.php\/gostudy\/508.html","title":{"rendered":"go swagger\u4f7f\u7528\u7b80\u4ecb\u4ee5\u53cahertz\u6846\u67b6\u4e2d\u96c6\u6210go-swagger"},"content":{"rendered":"\n

1.\u80cc\u666f<\/h1>\n\n\n\n

\u6700\u8fd1\u8d1f\u8d23\u7684\u9879\u76ee\u6a21\u5757\u9700\u8981\u4ece\u4e00\u4e2a\u5927\u5355\u4f53\u4ee3\u7801\u4ed3\u5e93\u4e2d\u8fc1\u79fb\u5230\u65b0\u7684\u4ee3\u7801\u4ed3\u5e93\u53e6\u8d77\u4e00\u4e2a\u65b0\u670d\u52a1\uff0c\u56e0\u6b64\u9700\u8981\u5c06\u6211\u8d1f\u8d23\u7684\u4ee3\u7801\u6a21\u5757\u4ece\u8001\u4ee3\u7801\u4ed3\u5e93\u4e2d\u8fc1\u79fb\u5230\u65b0\u7684\u4ee3\u7801\u4ed3\u5e93\u4e2d\u7136\u540e\u8fdb\u884c\u91cd\u6784\u3002\u8001\u7684\u5355\u4f53\u670d\u52a1\u662f\u4e00\u4e2a\u57fa\u4e8ego\u7684web\u6846\u67b6gin\u8fdb\u884c\u5305\u88c5\u540e\u7684web\u6846\u67b6\uff0c\u800c\u6211\u8d1f\u8d23\u7684\u4ee3\u7801\u8fc1\u79fb\u5230\u65b0\u7684\u670d\u52a1\u540e\u4f7f\u7528\u516c\u53f8\u5185\u90e8\u7684go web\u6846\u67b6hertz\u8fdb\u884c\u91cd\u6784\u3002\u8001\u7684\u4ee3\u7801\u6846\u67b6\u4e2d\u6ca1\u6709\u63a5\u5165\u7c7b\u4f3cswagger\u76f8\u5173\u7684\u751f\u6210open API\u6587\u6863\u7684\u7ec4\u4ef6\uff0c\u5bfc\u81f4\u5728\u524d\u540e\u7aef\u8054\u8c03\u8fc7\u7a0b\u4e2d\u5bf9\u4e8ehttp API\u63a5\u53e3\u7684\u5b9a\u4e49\u53ea\u80fd\u662f\u5199\u5728\u98de\u4e66\u6587\u6863\u4e2d\uff0c\u6c9f\u901a\u8d77\u6765\u975e\u5e38\u4e0d\u65b9\u4fbf\u3002\u56e0\u6b64\u4e3a\u4e86\u63d0\u9ad8\u524d\u540e\u7aefhttp\u63a5\u53e3\u6587\u6863\u7684\u5bf9\u63a5\u6548\u7387\uff0c\u5728\u65b0\u7684\u8fc1\u79fb\u670d\u52a1\u4e2d\u63a5\u5165go swagger\u751f\u6210http API\u63a5\u53e3\u7684\u6587\u6863\u3002<\/p>\n\n\n\n

2.go swagger\u7684\u5b89\u88c5\u548c\u4f7f\u7528<\/h1>\n\n\n\n

2.1\u5b89\u88c5swagger cli<\/h2>\n\n\n\n
 #  go\u7684\u7248\u672c\u662f go1.20.3 linux\/amd64
 go install github.com\/swaggo\/swag\/cmd\/swag@latest
 
 # \u67e5\u770bswagger\u7684\u7248\u672c
 swag -v
\/\/ swag version v1.16.2<\/pre>\n\n\n\n
2.2swagger cli\u7684\u4f7f\u7528<\/h2>\n\n\n\n
2.2.1\u67e5\u770b swag cli\u652f\u6301\u7684\u547d\u4ee4<\/h3>\n\n\n\n
swag init -h<\/pre>\n\n\n\n
\u53ef\u4ee5\u770b\u5230\u5f53\u524dswag\u53ea\u652f\u6301\u4e09\u4e2a\u547d\u4ee4\uff1a<\/p>\n\n\n\n
  1. swag init<\/li>
  2. swag fmt<\/li>
  3. swag help<\/li><\/ol>\n\n\n\n
    NAME:
       swag - Automatically generate RESTful API documentation with Swagger 2.0 for Go.
    \u200b
    USAGE:
       swag [global options] command [command options] [arguments...]
    \u200b
    VERSION:
       v1.16.2
    \u200b
    COMMANDS:
       init, i  Create docs.go
       fmt, f   format swag comments
       help, h  Shows a list of commands or help for one command
    \u200b
    GLOBAL OPTIONS:
       --help, -h     show help (default: false)
       --version, -v  print the version (default: false)<\/pre>\n\n\n\n
    2.2.2swag init\u7684\u4f7f\u7528<\/h3>\n\n\n\n
    swag init -h
    NAME:
       swag init - Create docs.go
    \u200b
    USAGE:
       swag init [command options] [arguments...]
    \u200b
    OPTIONS:
       --generalInfo value, -g value          API\u901a\u7528\u4fe1\u606f\u6240\u5728\u7684go\u6e90\u6587\u4ef6\u8def\u5f84\uff0c\u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\u5219\u57fa\u4e8eAPI\u89e3\u6790\u76ee\u5f55 (\u9ed8\u8ba4: \"main.go\")
       --dir value, -d value                  API\u89e3\u6790\u76ee\u5f55 (\u9ed8\u8ba4: \".\/\")
       --exclude value                        \u89e3\u6790\u626b\u63cf\u65f6\u6392\u9664\u7684\u76ee\u5f55\uff0c\u591a\u4e2a\u76ee\u5f55\u53ef\u7528\u9017\u53f7\u5206\u9694\uff08\u9ed8\u8ba4\uff1a\u7a7a\uff09
       --propertyStrategy value, -p value     \u7ed3\u6784\u4f53\u5b57\u6bb5\u547d\u540d\u89c4\u5219\uff0c\u4e09\u79cd\uff1asnakecase,camelcase,pascalcase (\u9ed8\u8ba4: \"camelcase\")
       --output value, -o value               \u6587\u4ef6(swagger.json, swagger.yaml and doc.go)\u8f93\u51fa\u76ee\u5f55 (\u9ed8\u8ba4: \".\/docs\")
       --parseVendor                          \u662f\u5426\u89e3\u6790vendor\u76ee\u5f55\u91cc\u7684go\u6e90\u6587\u4ef6\uff0c\u9ed8\u8ba4\u4e0d
       --parseDependency                      \u662f\u5426\u89e3\u6790\u4f9d\u8d56\u76ee\u5f55\u4e2d\u7684go\u6e90\u6587\u4ef6\uff0c\u9ed8\u8ba4\u4e0d
       --markdownFiles value, --md value      \u6307\u5b9aAPI\u7684\u63cf\u8ff0\u4fe1\u606f\u6240\u4f7f\u7528\u7684markdown\u6587\u4ef6\u6240\u5728\u7684\u76ee\u5f55
       --generatedTime                        \u662f\u5426\u8f93\u51fa\u65f6\u95f4\u5230\u8f93\u51fa\u6587\u4ef6docs.go\u7684\u9876\u90e8\uff0c\u9ed8\u8ba4\u662f
       --codeExampleFiles value, --cef value  \u89e3\u6790\u5305\u542b\u7528\u4e8e x-codeSamples \u6269\u5c55\u7684\u4ee3\u7801\u793a\u4f8b\u6587\u4ef6\u7684\u6587\u4ef6\u5939\uff0c\u9ed8\u8ba4\u7981\u7528
       --parseInternal                        \u89e3\u6790 internal \u5305\u4e2d\u7684go\u6587\u4ef6\uff0c\u9ed8\u8ba4\u7981\u7528
       --parseDepth value                     \u4f9d\u8d56\u89e3\u6790\u6df1\u5ea6 (\u9ed8\u8ba4: 100)
       --instanceName value                   \u8bbe\u7f6e\u6587\u6863\u5b9e\u4f8b\u540d (\u9ed8\u8ba4: \"swagger\")<\/pre>\n\n\n\n
    \u5728swag init\u547d\u4ee4\u4e2d\uff0c\u4ee5\u6211\u7684\u7ecf\u9a8c\u6765\u770b\u4e3b\u8981\u9700\u8981\u5173\u6ce8\u4ee5\u4e0b\u51e0\u4e2a\u547d\u4ee4\u53c2\u6570\uff1a<\/p>\n\n\n\n
    1. --dir value, -d value API\u89e3\u6790\u76ee\u5f55 (\u9ed8\u8ba4: \".\/\")\uff0c\u591a\u4e2a\u76ee\u5f55\u53ef\u4ee5\u7528\u82f1\u6587\u9017\u53f7\",\"\u9694\u5f00\u3002\u5982\u679c\u4e0d\u6307\u5b9a\u8be5\u53c2\u6570\uff0c\u5c06\u4f1a\u9ed8\u8ba4\u89e3\u6790\u5f53\u524d\u76ee\u5f55 .\/ \u4e0b\u7684\u6240\u6709API\u6ce8\u91ca\u3002\u8be5\u53c2\u6570\u53ef\u4ee5\u6307\u5b9a\u591a\u4e2a\u76ee\u5f55\uff0c\u6bcf\u4e2a\u76ee\u5f55\u4e4b\u95f4\u7528\u3002\u6bd4\u5982\u6307\u5b9a\u751f\u6210\u4e24\u4e2a\u6587\u4ef6\u5939 .\/test1\u3001.\/test2\u4e0b\u7684\u6240\u6709API\u6587\u6863\uff0c\u90a3\u4e48\u53ef\u4ee5\u8fd9\u6837\u6307\u5b9a\uff1aswag init -d .\/test1,.\/test2\u3002<\/li>
    2. --generalInfo value, -g value API\u901a\u7528\u4fe1\u606f\u6240\u5728\u7684go\u6e90\u6587\u4ef6\u8def\u5f84.\u5982\u679c\u4e0d\u6307\u5b9a\u8be5\u53c2\u6570\uff0c\u9ed8\u8ba4\u4f1a\u4f7f\u7528\u5f53\u524d\u9879\u76ee\u76ee\u5f55\u4e0b .\/main.go\u4f5c\u4e3aAPI\u901a\u7528\u4fe1\u606f\u6240\u5728\u7684go\u6e90\u6587\u4ef6\u8def\u5f84\u3002\u5982\u679c\u6307\u5b9a\u4e86 -d\u53c2\u6570\uff0c\u90a3\u4e48\u5219\u662f\u76f8\u5bf9\u4e8e-d\u53c2\u6570\u76ee\u5f55\u4e0b\u7684.go\u6587\u4ef6\u8def\u5f84\u3002\u6bd4\u5982<\/li><\/ol>\n\n\n\n
      swag init -d .\/test1,.\/test2 -g swagger_api.go\uff0c\u90a3\u4e48\u5c31\u8bf4\u660eAPI\u901a\u7528\u4fe1\u606f\u6240\u5728\u7684go\u6e90\u6587\u4ef6 swagger_api.go\u662f\u5728 .\/test1\u6216\u8005 .\/test2\u76ee\u5f55\u4e4b\u4e0b\u3002<\/p>\n\n\n\n
      1. --exclude value \u89e3\u6790\u626b\u63cf\u65f6\u6392\u9664\u7684\u76ee\u5f55\uff0c\u591a\u4e2a\u76ee\u5f55\u53ef\u7528\u9017\u53f7\u5206\u9694\uff08\u9ed8\u8ba4\uff1a\u7a7a\uff09\u3002\u6307\u5b9a\u4e86\u76ee\u5f55\u4e4b\u540e\u89e3\u6790API\u65f6\u5019\u4e0d\u4f1a\u89e3\u6790\u8be5\u76ee\u5f55\u5217\u8868\u4e0b\u7684API\u3002<\/li>
      2. --parseVendor \u662f\u5426\u89e3\u6790vendor\u76ee\u5f55\u91cc\u7684go\u6e90\u6587\u4ef6\uff0c\u9ed8\u8ba4\u4e0d\u4e0d\u89e3\u6790\u3002<\/li>
      3. --parseDependency \u662f\u5426\u89e3\u6790\u4f9d\u8d56\u76ee\u5f55\u4e2d\u7684go\u6e90\u6587\u4ef6\uff0c\u9ed8\u8ba4\u4e0d\u89e3\u6790\u3002\u5982\u679c\u9700\u8981\u89e3\u6790\u7684API\u4e2d\u5f15\u7528\u4e86\u4f9d\u8d56\u6587\u4ef6\u7684\u7ed3\u6784\u4f53\uff0c\u90a3\u4e48\u9700\u8981\u6307\u5b9a\u8be5\u53c2\u6570\u3002<\/li><\/ol>\n\n\n\n
        2.2.3 swag fmt\u7684\u4f7f\u7528<\/h3>\n\n\n\n
        swag fmt<\/pre>\n\n\n\n
        NAME:
           swag fmt - format swag comments \u7528\u4e8e\u683c\u5f0f\u5316API\u7684\u6ce8\u91ca
        \u200b
        USAGE:
           swag fmt [command options] [arguments...]
        \u200b
        OPTIONS:
           --dir value, -d value          API\u89e3\u6790\u76ee\u5f55 (\u9ed8\u8ba4: \".\/\")
           --exclude value                \u89e3\u6790\u626b\u63cf\u65f6\u6392\u9664\u7684\u76ee\u5f55\uff0c\u591a\u4e2a\u76ee\u5f55\u53ef\u7528\u9017\u53f7\u5206\u9694\uff08\u9ed8\u8ba4\uff1a\u7a7a\uff09
           --generalInfo value, -g value  API\u901a\u7528\u4fe1\u606f\u6240\u5728\u7684go\u6e90\u6587\u4ef6\u8def\u5f84\uff0c\u5982\u679c\u662f\u76f8\u5bf9\u8def\u5f84\u5219\u57fa\u4e8eAPI\u89e3\u6790\u76ee\u5f55 (\u9ed8\u8ba4: \"main.go\")
           --help, -h                     show help (default: false)<\/pre>\n\n\n\n
        3.hertz\u6846\u67b6\u4e2d\u5f15\u5165go-swagger<\/h1>\n\n\n\n
        3.1\u5feb\u901f\u751f\u6210hert\u670d\u52a1\u4ee3\u7801<\/h2>\n\n\n\n
        \u5177\u4f53\u53c2\u8003\uff1ahz \u5b89\u88c5<\/a><\/p>\n\n\n\n
        # \u5728 GOPATH \u5916\u6267\u884c\uff0c\u9700\u8981\u6307\u5b9a go mod \u540d
        hz new -module hertz-web
        \u200b
        # \u6574\u7406 & \u62c9\u53d6\u4f9d\u8d56
        go mod tidy
        \u200b<\/pre>\n\n\n\n
        \u5220\u9664\u4e0d\u5fc5\u8981\u7684\u5305\u76ee\u5f55\uff0c\u5e76\u65b0\u5efa swagger_demo,types\u76ee\u5f55\uff1a<\/p>\n\n\n\n
        .
        \u251c\u2500\u2500 build.sh
        \u251c\u2500\u2500 go.mod
        \u251c\u2500\u2500 go.sum
        \u251c\u2500\u2500 main.go             # main\u65b9\u6cd5\u5165\u53e3
        \u251c\u2500\u2500 router.go
        \u251c\u2500\u2500 router_gen.go
        \u251c\u2500\u2500 swagger_demo        # \u5b58\u653eAPI\u63a5\u53e3\u4ee5\u53ca swagger\u901a\u7528\u4fe1\u606f\u63a5\u53e3\u7684\u5305
        \u2502   \u2514\u2500\u2500 swagger_api.go  # \u5305\u542b\u4e86swagger\u901a\u7528\u4fe1\u606f\u63a5\u53e3\u4ee5\u53ca\u6211\u4eec\u9700\u8981\u6d4b\u8bd5\u7684\u63a5\u53e3
        \u2514\u2500\u2500 types               # \u5b58\u653e\u8bf7\u6c42\u548c\u54cd\u5e94\u7684\u7ed3\u6784\u4f53
            \u2514\u2500\u2500 view.go
        \u200b<\/pre>\n\n\n\n
        3.2\u5f15\u5165go-swagger<\/h2>\n\n\n\n
        3.2.1 view.go\u6587\u4ef6<\/h3>\n\n\n\n
        \/*
            @author: 24029
        \u200b
        @since: 2023\/9\/3 22:03:24
        @desc:
        *\/
        package types
        \u200b
        \/\/ BaseRes \u54cd\u5e94\u7684\u57fa\u7c7b,\u8fd9\u91cc\u5305\u542b\u6cdb\u578bT
        type BaseRes[T any] struct {
            Code int    \/\/ 0\u6210\u529f\uff0c1\u5931\u8d25
            Msg  string \/\/ \u54cd\u5e94\u4fe1\u606f
            Data T      \/\/ \u54cd\u5e94\u6570\u636e
        }
        \u200b
        type AddUserReq struct {
            Name        string `json:\"name,omitempty\"  validate:\"true\"`        \/\/ \u7528\u6237\u540d,\u5fc5\u586b
            Password    string `json:\"password,omitempty\" validate:\"true\"`     \/\/ \u7528\u6237\u5bc6\u7801\uff0c\u5fc5\u586b
            Age         int    `json:\"age,omitempty\" validate:\"false\"`         \/\/ \u7528\u6237\u5e74\u9f84\uff0c\u9009\u586b
            Description string `json:\"description,omitempty\" validate:\"false\"` \/\/ \u7528\u6237\u63cf\u8ff0\uff0c\u9009\u586b
        }
        type GetUserReq struct {
            Name     string `json:\"name,omitempty\"  validate:\"true\"`    \/\/ \u7528\u6237\u540d,\u5fc5\u586b
            Password string `json:\"password,omitempty\" validate:\"true\"` \/\/ \u7528\u6237\u5bc6\u7801\uff0c\u5fc5\u586b
        }
        \u200b
        type GetUserRes struct {
            ID       int64  \/\/ \u7528\u6237ID
            Name     string `json:\"name,omitempty\"`     \/\/ \u7528\u6237\u540d
            Password string `json:\"password,omitempty\"` \/\/ \u7528\u6237\u5bc6\u7801
            Age      int    `json:\"age\"`                \/\/ \u7528\u6237\u5e74\u9f84
        }
        \u200b
        type DeleteUserReq struct {
            UserID string `json:\"user_id,omitempty\"  validate:\"true\"`
        }
        \u200b
        type UserDetailsReq struct {
            Name    string `json:\"name,omitempty\"  validate:\"true\"` \/\/ \u7528\u6237\u540d\uff0c\u5fc5\u586b
            Age     string `json:\"age,omitempty\"  validate:\"true\"`  \/\/ \u7528\u6237\u5e74\u9f84,\u5fc5\u586b
            Details string `json:\"details\"  validate:\"false\" `      \/\/ \u7528\u6237\u8be6\u7ec6\uff0c\u9009\u586b
        }
        \u200b<\/pre>\n\n\n\n
        3.2.2swagger_api.go\u6587\u4ef6<\/h3>\n\n\n\n
        \/*
            @author: 24029
        \u200b
        @since: 2023\/9\/3 21:47:51
        @desc:
        *\/
        package swagger_demo
        \u200b
        import (
            \"context\"
            \"github.com\/cloudwego\/hertz\/pkg\/app\"
            \"hertz-web\/types\"
            \"net\/http\"
        )
        \u200b
        \/\/ SaggerAPI godoc
        \/\/
        \/\/  @title                      \u6d4b\u8bd5 hertz\u96c6\u6210swagger API\u7ec4\u4ef6
        \/\/  @version                    1.0
        \/\/  @description                \u7528\u6237\u6d4b\u8bd5hertz\u6846\u67b6\u96c6\u6210go swagger\u7ec4\u4ef6.
        \/\/  @termsOfService             http:\/\/swagger.io\/terms\/
        \/\/  @contact.name               API Support
        \/\/  @contact.url                http:\/\/www.swagger.io\/support
        \/\/  @contact.email              support@swagger_demo.io
        \/\/  @license.name               Apache 2.0
        \/\/  @license.url                http:\/\/www.apache.org\/licenses\/LICENSE-2.0.html
        \/\/  @host                       localhost:8888
        \/\/  @BasePath                   \/api\/v1
        \/\/  @securityDefinitions.basic  BasicAuth
        \/\/  @externalDocs.description   OpenAPI
        \/\/  @externalDocs.url           https:\/\/swagger.io\/resources\/open-api\/
        func SaggerAPI() {
        \u200b
        }
        \u200b
        \/\/ GetUser godoc
        \/\/
        \/\/  @Summary        \u6839\u636e\u7528\u6237\u540d\u548c\u7528\u6237\u5bc6\u7801\u83b7\u53d6\u7528\u6237\u4fe1\u606f
        \/\/  @Description    1.\u5982\u679c\u7528\u6237\u540d\u4e0d\u5b58\u5728\uff0c\u90a3\u4e48\u63d0\u793a\u7528\u6237\u8be5\u7528\u6237\u4e0d\u5b58\u5728
        \/\/  @Description    2.\u5982\u679c\u5bc6\u7801\u4e0d\u6b63\u5e38\u90a3\u4e48\u63d0\u793a\u7528\u6237\u5bc6\u7801\u4e0d\u6b63\u786e\u3002
        \/\/  @Accept         application\/json
        \/\/  @Produce        application\/json
        \/\/  @Param          name        query       string  true    \"\u7528\u6237\u540d\"
        \/\/  @Param          password    query       string  true    \"\u7528\u6237\u5bc6\u7801\"
        \/\/  @Success        200         {object}    types.BaseRes[types.GetUserRes]
        \/\/  @Failure        400         {object}    types.BaseRes[error]
        \/\/  @Failure        401         {object}    types.BaseRes[error]
        \/\/  @Failure        404         {object}    types.BaseRes[error]
        \/\/  @Router         \/user\/get [get]
        func GetUser(c context.Context, ctx *app.RequestContext) {
            var req types.GetUserReq
            err := ctx.BindAndValidate(&req)
            if err != nil {
                ctx.JSON(http.StatusBadRequest, types.BaseRes[error]{
                    Code: 0,
                    Msg:  \"\u53c2\u6570\u7ed1\u5b9a\u5931\u8d25\",
                    Data: err,
                })
                return
            }
            res := types.GetUserRes{
                ID:       1,
                Name:     \"\",
                Password: \"\",
                Age:      0,
            }
            result := types.BaseRes[types.GetUserRes]{
                Code: 0,
                Data: res,
                Msg:  \"\",
            }
            ctx.JSON(http.StatusOK, result)
        }
        \u200b
        \/\/ AddUser godoc
        \/\/
        \/\/  @Summary        \u65b0\u589e\u7528\u6237\u4fe1\u606f
        \/\/  @Description    1.\u5982\u679c\u7528\u6237\u540d\u4e0d\u7b26\u5408\u89c4\u8303\uff0c\u5219\u7981\u6b62\u65b0\u589e\u8be5\u7528\u6237
        \/\/  @Description    2.\u5982\u679c\u7528\u6237\u540d\u5df2\u5b58\u5728\uff0c\u90a3\u4e48\u65b0\u589e\u7528\u6237\u5931\u8d25
        \/\/  @Accept         application\/json
        \/\/  @Produce        application\/json
        \/\/  @Param          req body        types.AddUserReq    true    \"\u65b0\u589e\u7528\u6237\u8bf7\u6c42\u53c2\u6570\"
        \/\/  @Success        200 {object}    types.BaseRes[any]
        \/\/  @Failure        400 {object}    types.BaseRes[error]
        \/\/  @Failure        401 {object}    types.BaseRes[error]
        \/\/  @Failure        404 {object}    types.BaseRes[error]
        \/\/  @Failure        500 {object}    types.BaseRes[error]
        \/\/  @Router         \/user\/add [post]
        func AddUser(c context.Context, ctx *app.RequestContext) {
            var req types.AddUserReq
            err := ctx.BindAndValidate(&req)
            if err != nil {
                ctx.JSON(http.StatusBadRequest, types.BaseRes[error]{
                    Code: 0,
                    Msg:  \"\u53c2\u6570\u7ed1\u5b9a\u5931\u8d25\",
                    Data: err,
                })
                return
            }
            result := types.BaseRes[any]{
                Code: 0,
                Msg:  \"\",
            }
            ctx.JSON(http.StatusOK, result)
        }
        \u200b
        \/\/ DeleteUser godoc
        \/\/
        \/\/  @Summary        \u6839\u636e\u7528\u6237ID\u5220\u9664\u7528\u6237\u4fe1\u606f
        \/\/  @Description    1.\u5982\u679c\u7528\u6237\u540d\u4e0d\u7b26\u5408\u89c4\u8303\uff0c\u5219\u5220\u9664\u5931\u8d25
        \/\/  @Description    2.\u5982\u679c\u7528\u6237\u540d\u5df2\u5b58\u5728\uff0c\u90a3\u4e48\u53ef\u4ee5\u5220\u9664\u8be5\u7528\u6237
        \/\/  @Accept         application\/json
        \/\/  @Produce        application\/json
        \/\/  @Param          req body        types.DeleteUserReq true    \"\u5220\u9664\u7528\u6237\u8bf7\u6c42\u53c2\u6570\"
        \/\/  @Success        200 {object}    types.BaseRes[any]
        \/\/  @Failure        400 {object}    types.BaseRes[error]
        \/\/  @Failure        401 {object}    types.BaseRes[error]
        \/\/  @Failure        404 {object}    types.BaseRes[error]
        \/\/  @Failure        500 {object}    types.BaseRes[error]
        \/\/  @Router         \/user\/delete [delete]
        func DeleteUser(c context.Context, ctx *app.RequestContext) {
            var req types.DeleteUserReq
            err := ctx.BindAndValidate(&req)
            if err != nil {
                ctx.JSON(http.StatusBadRequest, types.BaseRes[error]{
                    Code: 0,
                    Msg:  \"\u53c2\u6570\u7ed1\u5b9a\u5931\u8d25\",
                    Data: err,
                })
                return
            }
            result := types.BaseRes[any]{
                Code: 0,
                Msg:  \"\",
            }
            ctx.JSON(http.StatusOK, result)
        }
        \u200b
        \/\/ GetUserByID godoc
        \/\/
        \/\/  @Summary        \u6839\u636e\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u4fe1\u606f
        \/\/  @Description    \u5982\u679c\u7528\u6237\u540d\u4e0d\u5b58\u5728\uff0c\u90a3\u4e48\u8fd4\u56de\u7a7a\u4fe1\u606f\uff1b\u5982\u679c\u7528\u6237\u5b58\u5728\u90a3\u4e48\u8fd4\u56de\u5177\u4f53\u4fe1\u606f
        \/\/  @Accept         application\/json
        \/\/  @Produce        application\/json
        \/\/  @Param          user_id     query       string  true    \"\u7528\u6237ID\"
        \/\/  @Param          password    query       string  true    \"\u7528\u6237\u5bc6\u7801\"
        \/\/  @Success        200         {object}    types.UserDetailsReq
        \/\/  @Failure        400         {object}    types.BaseRes[error]
        \/\/  @Failure        401         {object}    types.BaseRes[error]
        \/\/  @Failure        404         {object}    types.BaseRes[error]
        \/\/  @Failure        500         {object}    types.BaseRes[error]
        \/\/  @Router         \/user\/get\/:id [get]
        func GetUserByID(c context.Context, ctx *app.RequestContext) {
            var req types.GetUserReq
            err := ctx.BindAndValidate(&req)
            if err != nil {
                ctx.JSON(http.StatusBadRequest, types.BaseRes[error]{
                    Code: 0,
                    Msg:  \"\u53c2\u6570\u7ed1\u5b9a\u5931\u8d25\",
                    Data: err,
                })
                return
            }
            res := types.GetUserRes{
                ID:       1,
                Name:     \"\",
                Password: \"\",
                Age:      0,
            }
            result := types.BaseRes[types.GetUserRes]{
                Code: 0,
                Data: res,
                Msg:  \"\",
            }
            ctx.JSON(http.StatusOK, result)
        }
        \u200b<\/pre>\n\n\n\n
        \u6ce8\u610f\u4e8b\u9879\uff1a<\/p>\n\n\n\n
        1. \u5728API\u6ce8\u91ca\u4e2d\uff0c\u7528\u6237\u81ea\u5b9a\u4e49\u7ed3\u6784\u4f53\u5982\u679c\u6709\u5305\u542b\u6cdb\u578b\uff0c\u90a3\u4e48\u5728\u4f7f\u7528\u7c7b\u578b\u65f6\u5019\u9700\u8981\u5c06\u6cdb\u578b\u6307\u5b9a\u4e3a\u5177\u4f53\u7c7b\u578b\uff0c\u5426\u5219\u4f1a\u62a5\u9519\u3002<\/li><\/ol>\n\n\n\n
          \u6bd4\u5982 types.BaseRes[T any]\u7684\u81ea\u5b9a\u4e49BaseRes\u662f\u4e00\u4e2a\u5305\u542b\u6cdb\u578b\u7684\u7ed3\u6784\u4f53\uff0c\u56e0\u6b64\u5728\u4f7f\u7528\u65f6\u5019\u9700\u8981\u6307\u5b9a\u5176\u5177\u4f53\u7c7b\u578b\uff1a types.BaseRes[types.GetUserRes],\u8fd9\u6837\u624d\u80fd\u6b63\u5e38\u89e3\u6790\u6210\u529f\u3002<\/p>\n\n\n\n
          3.2.3\u751f\u6210 swag doc\u6587\u6863\u4ee3\u7801<\/h3>\n\n\n\n
          # \u683c\u5f0f\u5316\u5e76\u89e3\u6790 .\/swagger_demo,.\/types\u5305\u4e0b\u7684API\u6ce8\u91ca\u751f\u6210 swag API\u6587\u6863
          swag fmt & swag init -d .\/swagger_demo,.\/types -g swagger_api.go <\/pre>\n\n\n\n
          [1] 20301
          2023\/09\/03 23:23:03 Generate swagger docs....
          2023\/09\/03 23:23:03 Generate general API Info, search dir:.\/swagger_demo
          [1]  + 20301 done       swag fmt
          2023\/09\/03 23:23:06 Generate general API Info, search dir:.\/types
          2023\/09\/03 23:23:07 Generating types.BaseRes-types_GetUserRes
          2023\/09\/03 23:23:07 Generating types.GetUserRes
          2023\/09\/03 23:23:07 Generating types.BaseRes-error
          2023\/09\/03 23:23:07 Generating types.AddUserReq
          2023\/09\/03 23:23:07 Generating types.BaseRes-any
          2023\/09\/03 23:23:07 Generating types.DeleteUserReq
          2023\/09\/03 23:23:07 Generating types.UserDetailsReq
          2023\/09\/03 23:23:07 create docs.go at docs\/docs.go
          2023\/09\/03 23:23:07 create swagger.json at docs\/swagger.json
          2023\/09\/03 23:23:07 create swagger.yaml at docs\/swagger.yaml<\/pre>\n\n\n\n
          .\/
          \u251c\u2500\u2500 build.sh
          \u251c\u2500\u2500 docs                      #\u751f\u6210\u7684swagger API\u6587\u6863\u76ee\u5f55
          \u2502   \u251c\u2500\u2500 docs.go
          \u2502   \u251c\u2500\u2500 swagger.json
          \u2502   \u2514\u2500\u2500 swagger.yaml
          \u251c\u2500\u2500 go.mod
          \u251c\u2500\u2500 go.sum
          \u251c\u2500\u2500 main.go
          \u251c\u2500\u2500 router.go
          \u251c\u2500\u2500 router_gen.go
          \u251c\u2500\u2500 swagger_demo
          \u2502   \u2514\u2500\u2500 swagger_api.go
          \u2514\u2500\u2500 types
              \u2514\u2500\u2500 view.go
          \u200b<\/pre>\n\n\n\n
          \"image-20230903234145966\"\/<\/figure >\n