Gin 使用swagger

1. 安装Swagger

安装golang对应的swagger开源库

go get -u github.com/swaggo/swag/cmd/swag@v1.7.6
go get -u github.com/swaggo/gin-swagger@v1.3.3
go get -u github.com/swaggo/files
go get -u github.com/alecthomas/template

验证是否安装成功

swag -v

2. 使用Swagger

在添加swagger相关路由时，应该使用gin-swagger/swaggerFiles中的Handlers，而不是swaggo/files中的Handlers

import (
    ginSagger "github.com/swaggo/gin-swagger"
    swaggerFiles "github.com/swaggo/files"
)
// 错误示例
rg.GET("/swagger/*any", ginSagger.WrapHandler(swaggerFiles.Handler))

import (
    ginSagger "github.com/swaggo/gin-swagger"
    "github.com/swaggo/gin-swagger/swaggerFiles"
)
// 错误示例
rg.GET("/swagger/*any", ginSagger.WrapHandler(swaggerFiles.Handler))

详细标签可以到官方处查看swaggo/swag

3. 问题

访问swagger报错：

原因： 在注册路由时没有引入项目的docs包，应该添加如下代码

import _ "example/docs"