gin集成Swagger-UI

时间:2025-02-25 16:35:57

gin 中间件使用 Swagger 2.0 自动生成 RESTFUL API 文档。

完整例子:

/Mzihao/go-logistics

1. 安装Swagger

使用以下命令下载Swag for Go:

go get -u github.com/swaggo/swag/cmd/swag

在 Go 项目根路径运行Swag , Swag将解析注释并生成所需的文件和文件夹。

swag init

# 可加载外部包
swag init --parseDependency --

参数解释:

参数名 含义解释
parseInternal 解析内部依赖包,默认值: false
parseDependency 解析外部依赖包,默认值: false
parseDepth 解析依赖包深度,默认值:100

生成目录如下:

.
├── docs
│ ├──
│ ├──
│ └──
├──
├──
└──

使用以下命令下载gin-swagger:

go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo