swagger, swag, gin-swagger之间的关系

已于 2022-02-14 11:20:12 修改
阅读量556 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： restful json golang
于 2022-02-14 11:19:23 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/oscarun/article/details/122920834
Swagger是一个用于生成和描述RESTful API的服务，支持多种语言。Swag是Go语言中将注释转换为Swagger接口描述文件的工具，而Gin-Swagger则专门针对使用Gin框架的Go应用，帮助生成Swagger接口文档。通过这些工具，开发者可以轻松管理和调用API。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

很多人不太理解 swagger, swag, gin-swagger 的关系，本文简单总结一下。

  1. swagger 可以理解成一个用于生成、描述和调用RESTful接口的服务，也就是我们经常见到的swagger页面，可见的文件格式就是swagger.json, swagger.yaml之类的接口描述文件，swagger不区分语言，事实上大部分的语言都有生成swagger接口描述文件的工具
  2. swag 可以理解成是一个用Go写的一个将Go的注释转化成上述说的swagger接口的描述文件的工具
  3. gin-swagger gin是一个Go写的Web框架，但是不提供接口文档工具，所以gin-swagger就是一个帮助用gin写的Web后台转化成swagger接口描述文件的工具
runzhliu
关注
【协作提效 Go - gin ! swagger】
qq_38428433的博客
08-02 784
Swagger 是一个用于设计、构建、记录和使用 RESTful Web 服务的工具集。而对于我们的研发团队来说，swagger可以清晰的定义接口，即是代码也是文档，大大提升了前后端沟通的效率，团队内协作的效率！而Go - Gin框架支持Swagger，下面一步一步来看下如何使用库来生成和展示接口文档。
gin集成Swagger-UI
weixin_44840774的博客
03-27 846
gin 中间件使用 Swagger 2.0 自动生成 RESTFUL API 文档。 1. 安装Swagger 使用以下命令下载Swag for Go： go get -u github.com/swaggo/swag/cmd/swag 在 Go 项目根路径运行Swag ， Swag将解析注释并生成所需的文件和文件夹。 swag init 生成目录如下： . ├── docs │ ├── docs.go │ ├── swagger.json │ └── swagger.yaml ├── g
Go-go-swagger用go语言实现Swagger2.0
08-14
go-swagger：用go语言实现Swagger 2.0
GO语言gin框架实战-03-swagger和接口文档
架构+开发+运维
11-08 1952
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
搞定gin环境搭建+Gin-swagger部署！
最新发布
weixin_42113956的博客
06-06 213
本文介绍了如何使用Gin框架创建Web服务并集成gin-swagger生成API文档。主要内容包括：1)创建Gin实例并配置简单路由；2)安装swag CLI工具和gin-swagger依赖；3)配置swagger文档注释和路由；4)通过swag init命令生成文档并访问。文章还展示了swagger UI界面截图，提供了从项目初始化到API文档生成的全流程指导，适合需要快速搭建Web服务并生成文档的开发者参考。
【Web】go后端自动生成文档神器 gin - swagger gin 中间件自动生成 RESTful API 文档。
csxylrf的博客
06-15 618
官方的解释很清晰，我这里翻译一下[官方github](
swagger安装
yangyw
06-28 895
swagger接口文档
【RESTful API 文档】为 Gin 开发项目加上 Swag 和 gin-swagger 自动生成 RESTful API 接口文档
这里主要记录一些学到的新知识
08-16 358
为 Gin 开发项目加上 Swag 和 gin-swagger 自动生成 RESTful API 接口文档。 并解决了【‘swag’ 不是内部或外部命令，也不是可运行的程序或批处理文件】 问题
gin-swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 gin 中间件
07-24
gin 中间件使用 Swagger 2.0 自动生成 RESTful API 文档。 用法 开始使用它 向您的 API 源代码添加注释，。 使用以下命令下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的 Go 项目...
gin配置swagger文档
水痕
09-13 1530
【代码】gin配置swagger文档。
Go --- gin配置swagger
weixin_52025712的博客
03-14 2012
gin配置swagger所有代码和命令 不多说废话，直接开始 准备工作： 下载swag for go go get -u github.com/swaggo/swag/cmd/swag 然后执行 swag init 你就会发现自己的项目中多出一个docs文档文件 下载 gin-swagger go get -u github.com/swaggo/gin-swagger go get -u github.com/swaggo/files 在你的代码中引入 import "git
Swagger
cts529269539的专栏
01-29 2911
1：认识Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。  作用：     1. 接口的文档在线自动生成。     2. 功能测试。  Swagger是一组开源项目，其中主要要项目如
swag使用
热门推荐
kismile
03-26 1万+
[toc] Java使用Spring Boot写Restful API时，可以在代码里用注解来标识API，编译为Jar包后，运行时Web应用可以直接托管API文档。具体的可以参考文章：使用swagger来做API文档。 那么golang系有没有类似的做法呢？ 有是有的，只是没有springfox的那么方便就是了。 swaggo提供了golang版本的swagger自动生产Restful API文档...
gin运行多个服务，生成对应不同的swgger文档
lv_qi的博客
10-14 493
gin运行多个服务，生成对应不同的swgger文档
golang 引入swagger（iris、gin）
weixin_45565886的博客
02-06 4373
golang 引入swagger（iris、gin）
Swaggo快速上手
delete_you的博客
01-22 1923
快速上手使用swaggo并整合到gin中去
简述 Gin 框架如何集成swagger
jinjiangcc
02-01 8070
简述Gin框架集成swagger过程 1、安装 swag swag 用于生成 docs 文件夹(swagger文档程序使用) 安装完成后会在 ${GOPATH}/bin生成一个执行文件 2、安装依赖包 github.com/gin-gonic/gin github.com/swaggo/gin-swagger 3、示例程序 /** * Created by martin on 01/02/2...
Gin-Swagger的使用
qq_51898139的博客
08-22 4145
gin-swagger的使用
利用 gin-swagger 实现 RESTful API 文档自动生成
资源摘要信息:"Gin-swagger是一个中间件库，它利用Swagger 2.0规范来自动生成RESTful API文档。这一中间件是为Gin框架特别设计的，Gin是用Go语言编写的高性能Web框架，适用于开发RESTful API。" 知识点详细说明: 1...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值