golang使用swagger的过程详解

更新时间：2024年06月06日 10:33:25 作者：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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Go语言中make和new函数的用法与区别
这篇文章介绍了Go语言中make和new函数的用法与区别，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-07-07
在Golang中使用C语言代码实例
这篇文章主要介绍了在Golang中使用C语言代码实例,本文先是给出了一个Hello World例子、Golang 引用 C例子,并总结了一些要注意的地方,需要的朋友可以参考下
2014-10-10
手把手教你用VS code快速搭建一个Golang项目
Go语言是采用UTF8编码的,理论上使用任何文本编辑器都能做Go语言开发,下面这篇文章主要给大家介绍了关于使用VS code快速搭建一个Golang项目的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
2023-04-04
golang分层测试之http接口测试入门教程
这篇文章主要介绍了golang分层测试之http接口测试入门教程，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-12-12
浅谈Golang是如何读取文件内容的(7种)
这篇文章主要介绍了浅谈Golang是如何读取文件内容的，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
详解Go中的高效切片拼接和Go1.22提供的新方法
在 Go 语言中,切片拼接是一项常见的操作,但如果处理不当,可能会导致性能问题或意外的副作用,本文将详细介绍几种高效的切片拼接方法,希望对大家有所帮助
2024-01-01
Goland和IDEA换行符的设置方式
这篇文章主要介绍了Goland和IDEA换行符的设置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-07-07
Golang如何自定义logrus日志保存为日志文件
这篇文章主要给大家介绍了关于Golang如何自定义logrus日志保存为日志文件的相关资料,logrus是目前Github上star数量最多的日志库,logrus功能强大,性能高效,而且具有高度灵活性,提供了自定义插件的功能,很多开源项目都是用了logrus来记录其日志,需要的朋友可以参考下
2024-02-02
go语言区块链实战实现简单的区块与区块链
这篇文章主要为大家介绍了go语言区块链的实战学习，来实现简单的区块与区块链示例过程，有需要的朋友可以借鉴参考下，希望能够有所帮助
2021-10-10
Golang使用Swag搭建api文档的全过程
Gin是Golang目前最为常用的Web框架之一,公司项目验收需要API接口设计说明书（Golang后端服务基于Gin框架编写）,所以本文给大家介绍了Golang使用Swag搭建api文档的全过程,需要的朋友可以参考下
2024-02-02