golang使用swagger

1、安装

go install github.com/swaggo/swag/cmd/swag@latest
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/gin-swagger/swaggerFiles

2、生成swag文档

命令:swag init

错误
'swag' 不是内部或外部命令,也不是可运行的程序
或批处理文件。
 go install github.com/swaggo/swag/cmd/swag@latest

需要安装到bin环境变量

3、在main上添加

// @title Swagger Example API
// @version 1.0.0
// @description This is a sample Server pets
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name x-token
// @BasePath /
func main() {

4、 引入docs文档

报错 Fetch error Internal Server Error doc.json 是没有引入docs

5、创建swagger路由

engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

 6、再接口上添加注释

// @Tags CheckApi
// @Summary 检测测试
// @accept application/json
// @Produce application/json
// @Param data query request.Req true "查询渠道"
// @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
// @Router /router/addr [get]

6、success 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值