gin集成Swagger-UI

本文档介绍了如何在Gin框架中集成Swagger 2.0,通过使用Swag for Go和gin-swagger中间件,自动生成RESTful API的文档。详细步骤包括安装Swagger、设置配置,并提供了查看生成的Swagger UI的地址。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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

完整例子:

https://github.com/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
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
└── main.go

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

go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值