Go Gin框架导入swagger

已于 2024-04-19 22:11:46 修改
阅读量235 收藏 1
点赞数 6
分类专栏： go开发 文章标签： gin go
于 2024-04-12 14:12:50 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_63785498/article/details/137678774
版权

首先需要在main函数上面添加basepath

我的路由结果如下
-api

        --auth

                ---register

        --user

                ---info

                ---list ····

// @title           Swagger测试
// @version         1.0
// @description     This is a sample server celler server.

// @contact.name   API Support
// @contact.url    http://www.swagger.io/support
// @contact.email  support@swagger.io

// @BasePath  /api

然后在 register 这个controller上也加上注解 param自己修改，这里只做出例子

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

把上面的东西都下了之后，go的bin文件里面会有swag.exe

然后在控制台下面输入 swag init，之后会出现docs这个目录，于是就可以启动项目了

访问http://url/swagger/index.html

参考链接：

swag | Golang中文学习文档
https://www.cnblogs.com/Ivan-Wu/p/15821288.html

Golang gin框架使用swagger生成接囗文档_golang swagger-CSDN博客

b1uesk9
关注
  • 6
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
go语言gin框架数据绑定常用api
11-03
go语言gin框架可以让开发者更快的开发web运用，结合go语言自带的并发优势，运行速度，让用户运用体验飞一般的感觉，go语言也成为游戏服务器的首选开发语言。不管你是go小白，还是其他开发语言的大佬，gin框架可以让...
Go的Gin框架整合Swagger
u013068184的博客
06-11 8081
最近在研究Go的Gin框架，本文简单记录怎么整合Swagger。 版本信息： gin v1.6.3 swag v1.6.7 首先下载安装Gin以及Swagger依赖包： go get -u github.com/gin-gonic/gin go get -u github.com/swaggo/swag/cmd/swag 若报以下错： go get github.com/gin-gonic/gin: module github.com/gin-gonic/gin: Get "https://proxy.
Golang gin框架使用swagger生成接囗文档
ling1998的博客
04-16 6208
0、开发环境 操作系统：Win10 Golang版本：1.15 1、安装swag go get github.com/swaggo/swag/cmd/swag 此时会在环境变量 GOBIN目录中生成swag.exe，如下图所示 验证是否安装成功 F:\Golang\TalentChain\talentchain>swag -v swag version v1.8.1 2、安装依赖包 go get -u github.com/swaggo/gin-swagger go ge.
【Go】Go Swagger 生成和转 openapi 3.0.3
非晓为骁的博客
05-11 1159
本文档主要描述在 gin 框架下用 gin-swagger 生成 swagger.json 的内容，中间猜的坑。以及，如何把 swagger 2.0 转成 openapi 3.0.3
GO语言gin框架实战-03-swagger和接口文档
运维玄德公
11-08 1620
1. GET 1.1 query模式 1.2 path 模式 2 POST 2.1 body模式 2.2 formData模式 3. PUT 3.1 body模式 3.2 formData模式 4. DELETE 4.1 query 4.2 Path
go语言web开发系列之二十七:gin框架:用gin-swagger实现接口文档
刘老师的技术森林
02-03 2992
一，安装用到的库 1，swag库的地址: https://github.com/swaggo/swag 2，安装swag命令: liuhongdi@ku:~$ go get -u github.com/swaggo/swag/cmd/swag 测试安装是否成功? liuhongdi@ku:/data/liuhongdi/digv27$ /home/liuhongdi/go/bin/swag -v swag version v1.6.9 在项目包含main.go文件的目录下执行: liu
Go语言gin框架+gorm框架项目：后端配置swagger
pyscl01的博客
05-08 2031
Go语言gin框架+gorm框架项目：后端配置swagger的详细步骤
Go语言中的gin框架之GET/POST请求参数接收传值（五）
06-15
在Go语言中，Gin框架是一个非常流行的HTTP微服务框架，它提供了简洁的API来处理HTTP请求，使得开发Web应用变得更加高效。本教程将详细讲解如何在Gin中接收GET和POST请求的参数。 首先，我们需要引入Gin库。在`go....
基于Go语言Gin框架的Web项目骨架设计源码
最新发布
05-23
GinSkeleton是一个基于Go语言Gin框架封装的Web项目骨架，包含145个文件，其中包括94个Go源文件、36个Markdown文件、3个文本文件、3个SQL文件、2个YAML文件、1个Git忽略文件、1个LICENSE文件、1个Go Mod文件、1个Sum...
go 语言框架 gin中文文档.pdf
09-24
Gin 是一个 go 写的 web 框架，具有高性能的优点。官方地址：https://github.com/gin-gonic/gin 前提: 使用gin需要Go的版本号为1.6或更高。 若要将请求主体绑定到结构体中，请使用模型绑定，目前支持JSON、XML、YAML...
Go语言gin框架的安装
01-07
问题来了，因为墙的问题，go get会很慢，所以命令行里面半天什么反应也没有，不要急，慢慢等着就会看到gin-gonic/gin这个目录出现 这个时候命令行还是没有结束，表示还在下一些东西。有的时候可能心急的人就停了...
go 语言框架 gin中文文档
09-11
go 语言框架 gin 的中文文档。说明 安装与配置 框架架构 路由 控制器 请求 响应 中间件 数据库
Gin-swaggo为gin框架提供Swagger 文档
qq_42901723的博客
09-08 426
4.构建您的应用程序，然后访问 http://localhost:8080/swagger/index.html ，您将看到您的 Swagger UI。3.像这样导入文档：我假设您的项目名为 github.com/go-project-name/docs。2.使用 swag init 命令生成一个文档，生成的文档将存储在 docs/ 中。那么如何在上面的api上使用gin-swagger呢？只需遵循以下指南即可。那么如何在上面的api上使用gin-swagger呢？只需遵循以下指南即可。
Golang | Web开发之Gin使用swag生成项目的Swagger-API接口文档
WeiyiGeek 唯一极客IT知识分享
06-13 2039
Swagger工具是由原始“Swagger”规范背后的团队开发的。Swagger提供了最强大和最容易使用的工具，以充分利用OpenAPI规范。go-swagger 是一个主要生成或分析源代码的工具，我们可以使用 go-swagger 工具为Gin项目使用Swagger 2.0自动生成RESTful API文档。
Swagger学习笔记（基于Go-Gin）
KeepCodeing
09-18 659
文章目录Swagger学习（基于Go-Gin框架）狂神说Swagger小结李文周SwaggerSwagger介绍第一步： 添加注释第二步：生成接口文档数据第三步：引入gin-swagger渲染文档数据小结go中文文档中的Swaggo介绍使用全局配置各项参数的作用各个接口的注释参数作用`Tags``Accept``Produce``Param`参数类型参数数据类型是否是必须参数描述其他属性`Success`Router生成文档与测试优化如果使用了Tokenswag-go说明文档（git hub）快速开始支持的
gin框架引入swagger
weixin_45309589的博客
04-29 329
上图圈红的内容为swagger识别的内容，代码写好后，执行swag init会生成文件，浏览器打开swagger网站会显示内容。swag -v来验证安装是否成功，成功会显示版本信息。2.命令行：swag init 初始化文件。1.首先引入所需要的包。
go集成gin+swagger
不积跬步，无以至千里；不积小流，无以成江海。
01-22 1253
1.安装 swag go get github.com/swaggo/swag/cmd/swag swag 用于生成 docs 文件夹(swagger文档程序使用) 安装完成后会在 ${GOPATH}/bin生成一个执行文件 2.编写代码 /** * Created by liuyusnhengsir on 23/01/2022 */ package main import ( _ "lys_gin_swag/docs" "github.com/gin-gonic/gin" ginSw
go语言gin框架中使用swagger
qq_33966898的博客
08-13 312
最后进入 http://localhost:8080/swagger/index.htm 即可看到swagger界面。下载完成后 查看安装状态，看到如下图说明安装成功。根目录下初始化swagger初始化命令示例。初始化成功后会在项目与根目录下看到以下文件。代码完成后在根目录下执行doc文档生成命令。......
go语言安装gin框架
07-27
要在Go语言中安装Gin框架，您可以按照以下步骤进行操作： 1. 首先，确保您已经成功安装了Go语言的开发环境。您可以在官方网站（https://golang.org/）下载并安装最新版本的Go。 2. 打开终端或命令提示符，并执行以下命令来安装Gin框架： ``` go get -u github.com/gin-gonic/gin ``` 这将从GitHub仓库下载并安装最新版本的Gin框架。 3. 安装完成后，您可以在Go项目中使用Gin框架。下面是一个简单的示例代码： ```go package main import ( "github.com/gin-gonic/gin" ) func main() { router := gin.Default() router.GET("/", func(c *gin.Context) { c.JSON(200, gin.H{ "message": "Hello, Gin!", }) }) router.Run(":8080") } ``` 您可以将上述代码保存为一个名为`main.go`的文件。 4. 在终端或命令提示符中，进入保存了代码的目录，并执行以下命令来运行程序： ``` go run main.go ``` 这将启动一个本地的服务器，并监听在`localhost:8080`上。 5. 现在，您可以在浏览器中访问`http://localhost:8080`，应该能够看到返回的JSON响应。 这样，您就成功地在Go语言中安装并使用了Gin框架。您可以通过阅读Gin框架的官方文档（https://gin-gonic.com/docs/）来了解更多关于该框架的详细信息和使用方法。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值