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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

HTTP服务压力测试工具及相关术语讲解
这篇文章主要为大家介绍了HTTP服务压力测试工具使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
2022-04-04
探索分析Go HTTP GET请求发送body
这篇文章主要为大家介绍了探索分析Go HTTP GET请求发送body,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-11-11
go语言Pflag Viper Cobra 核心功能使用介绍
这篇文章主要为大家介绍了go语言Pflag Viper Cobra 核心功能使用介绍，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-09-09
Golang原生rpc(rpc服务端源码解读)
本文主要介绍了Golang原生rpc(rpc服务端源码解读)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-04-04
Golang打包配置文件的实现示例
本文主要介绍了Golang打包配置文件的实现示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-12-12
Go数组与切片轻松掌握
在Java的核心库中，集合框架可谓鼎鼎大名：Array、List、Set等等，随便拎一个出来都值得开发者好好学习如何使用甚至是背后的设计源码。虽然Go语言没有如此丰富的容器类型，但也有一些基本的容器供开发者使用，接下来让我们认识一下这些容器类型吧
2022-11-11
golang修改结构体中的切片值方法
这篇文章主要介绍了golang修改结构体中的切片值方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
Go语言中iota的具体使用
Go语言中,iota是一个用于生成一系列相关常量值的常量生成器,常应用于枚举、位操作等场景,广泛用于定义HTTP状态码、权限控制等,本文就来介绍一下iota的具体使用,感兴趣的可以了解一下
2024-11-11
go语言实现字符串与其它类型转换(strconv包)
strconv包是Go语言标准库的一部分,主要提供字符串与基本数据类型之间的转换功能,使用strconv包可以方便地在不同类型之间进行转换,满足日常编程中的需求,感兴趣的可以了解一下
2024-10-10
浅析Go语言中内存泄漏的原因与解决方法
这篇文章主要来和大家聊一聊Go语言中内存泄漏的那些事,例如内存泄漏的原因与解决方法,文中的示例代码讲解详细,需要的小伙伴可以参考下
2024-02-02