golang使用swagger的过程详解
作者：lemonth
这篇文章主要介绍了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
到此这篇关于golang使用swagger的文章就介绍到这了,更多相关golang使用swagger内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！