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

您可能感兴趣的文章:

GoLang OS包以及File类型详细讲解
go中对文件和目录的操作主要集中在os包中，下面对go中用到的对文件和目录的操作，做一个总结笔记。在go中的文件和目录涉及到两种类型，一个是type File struct，另一个是type Fileinfo interface
2023-03-03
Go语言net/http库使用详解
net/http是Go语言标准库中用于处理HTTP协议的核心组件,它提供了完整HTTP客户端和服务器实现,这个包让开发者能够快速构建高性能的Web服务,无需依赖第三方框架,感兴趣的可以了解一下
2025-10-10
浅析Golang如何向已关闭的chan读写数据
这篇文章主要为大家详细介绍了Golang如何向已关闭的chan读写数据,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2024-02-02
Gin框架自带参数校验的使用详解
这篇文章主要为大家详细介绍了如何使用Gin框架自带的参数校验,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的小伙伴可以了解下
2023-09-09
详解Golang官方中的一致性哈希组件
这篇文章主要为大家详细介绍了Golang官方中的一致性哈希组件的相关知识，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一下
2023-04-04
一文带你学会使用Go语言实现自己的MCP服务端
这篇文章将带大家速览MCP的核心概念,并以Go语言为例,介绍如何开发MCP服务端和客户端,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下
2025-04-04
GoFrame gredis缓存DoVar及Conn连接对象的自动序列化
这篇文章主要为大家介绍了GoFrame gredis干货DoVar Conn连接对象自动序列化详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-06-06
多阶段构建优化Go 程序Docker镜像
这篇文章主要为大家介绍了多阶段构建优化Go 程序Docker镜像，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
Goland debug失效详细解决步骤(合集)
今天用Goland开发时,打断点,以debug方式运行,发现程序并没有断住,程序跳过了断点,直接运行结束,网上搜寻了大量文章,最后得以解决,特此在这里总结几种Goland debug失效常见情况,需要的朋友可以参考下
2025-02-02
golang 实现每隔几分钟执行一个函数
这篇文章主要介绍了golang 实现每隔几分钟执行一个函数，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12