Gin-swagger完整使用教程

准备工作

引入swaggo依赖：

## swagger 依赖
go get "github.com/swaggo/files"
go get "github.com/swaggo/gin-swagger"## swagger 命令行工具
go get -u github.com/swaggo/swag/cmd/swag
go install github.com/swaggo/swag/cmd/swag

项目地址：《gin-swagger项目地址Github》

进入正题

1、首先在main函数前添加描述：

// @title helloworld
// @version 1.0
// @description chenwenyu test helloworld
// @termsOfService http://swagger.io/terms/// @contact.name cwy
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html// @host cwy.helloworld.com
// @BasePath /base/path
func main() {}

2、注册swagger路由信息：

import (swaggerFiles "github.com/swaggo/files"ginSwagger "github.com/swaggo/gin-swagger"
)func main() {...//注册swagger路由router := gin.Default()router.GET("/swagger/*any", func(c *gin.Context) {ginSwagger.DisablingWrapHandler(swaggerFiles.Handler, "SWAGGER")(c)})...
}

3、给函数方法添加备注：

POST方法：

type ConfigParam struct {Switch          bool   `json:"switch" example:"true"`StorageTime     int    `json:"storage_time" example:"7"`StorageCapacity int    `json:"storage_capacity" example:"100"`InstanceMark    string `json:"instance_mark" example:"10.12.11.1_33066"`ClusterMark     string `json:"cluster_mark" example:"10.79.1.1_33066"`
}type FormRespFail struct {Status string `json:"status" example:"0001"`Msg    string `json:"msg" example:"some error"`
}type FormRespSuccess struct {Status string `json:"status" example:"0000"`Msg    string `json:"msg" example:"success"`
}// SetConfig
// @Summary SQLTest服务配置
// @Description  SQLTest服务配置
// @Tags SQLTest
// @Accept  json
// @Produce  json
// @Param body body ConfigParam true "请求body"
// @Success 200 {object} utils.FormRespSuccess
// @Router /api/v1/audit/config [post]
func (s *SQLTest) SetConfig(ctx *middleware.Context) {}

GET方法：

// GetConfig
// @Summary 查询SQLTest服务配置
// @Description  查询SQLTest服务配置
// @Tags SQLTest
// @Accept  json
// @Produce  json
// @Param instance_mark query string true "节点标识"
// @Param start_time query int true "查询起始时间"
// @Param end_time query int true "查询结束时间"
// @Param user query string false "执行用户"
// @Param start_exec_time query int false "执行时长下限"
// @Param end_exec_time query int false "执行时长上限"
// @Param content query string false "SQL内容"
// @Param next_id query int false "下一页ID"
// @Success 200 {object} utils.FormRespSuccess
// @Router /api/v1/audit/config [get]
func (s *SQLTest) GetConfig(ctx *middleware.Context) {}

4、文档初始化

cd helloworld #进入项目根路径
swag init -g ./src/cmd/main.go -o ./docs  #初始化文档

项目结构
```
./helloworld
├── docs
│   ├── docs.go
│   ├── swagger.json
│   └── swagger.yaml
├── go.mod
├── go.sum
└── src├──cmd├── main.go
```

swag init执行成功之后会在项目目录下出现docs子目录，子目录中会出现docs.go，swagger.json，swagger.yaml三个文件，随后在main文件中import docs模块

import (_ "helloworld/docs"
)

5、编译运行

编译运行服务，访问本地http://127.0.0.1:8000/base/path/swagger 即可访问swagger文档

Gin-swagger完整使用教程相关推荐

oracle oats 安装,Mentor完整培训教程.pdf
Mentor完整培训教程 MENTOR基本培训教程电路设计人员电路设计人员 MENTORMENTOR培训教程培训教程讲述人讲述人:: 叉叉刀片叉叉刀片叉叉刀片设计室 MENTOR基本培训教程 ...
GPT转MBR怎么转？GPT转MBR完整图文教程
GPT转MBR分区怎么转?现在很多笔记本的硬盘分区都是GPT模式,如果想装XP的话,那只能将GPT磁盘转换成MBR磁盘分区才行.接下来,简单说说如何将GPT分区转成MBR分区! 如果本身电脑有两个硬盘 ...
万能Ghost全攻略(最详细完整的教程)
万能Ghost全攻略(最详细完整的教程) 一.运行 Sysprep 工具的要求要使用 Sysprep 工具,计算机的硬件和相关设备必须满足下列要求: 1. 参考计算机和目标计算机必须具有兼 ...
Pycharm完整中文教程及安装配置
Pycharm完整中文教程 https://www.pycharm.net.cn/ https://blog.csdn.net/weixin_36411839/article/details/8228 ...
金泰克/tigo S300 240G SM225K H27QFG8PEM5R 完整开盘教程
金泰克/tigo S300 240G SM225K H27QFG8PEM5R 完整开盘教程前几天电脑运行中黑屏了,重启发现固态坏了,系统在主板的M2固态盘上,使用没影响.于是把马上三年质保的东芝盘反 ...
大白菜U盘启动盘制作工具完整使用教程
目录一.制作前的准备工作二.制作U盘启动盘三.将U盘设置为优先启动项四.U盘重装系统大白菜U盘启动盘制作工具完整使用教程大白菜是一款具有支持提取安装文件,并自动进行系统安装和引导修复过程等 ...
视频教程-最新完整react教程从入门到精通包教包会-ReactJS
最新完整react教程从入门到精通包教包会 10年以上开发经验,曾经是八维教育实训主任,千峰教育高级HTML5前端讲师,尚品中国创始人.现任程序思维创始人.曾和大厂.国企等大型企业合作开发项目.百余客 ...
android高级编程新浪,《C高级编程(第4版)》-完整教材教程
崇仁不畅陌生丽台怪声礼物两可.寰球撬杠倡导搏击电星新盘蒙住<C高级编程(第4版)>-完整教材教程,胚柄抽空绿化些微两路.恸哭浅山转折乐华被迫党员心咒.国网茶荷前镇鬼物奶羊,全班柳铁路遥橱窗 ...
android xfire,XFire完整入门教程
# re: XFire完整入门教程 2008-02-28 11:01 | milo 请问下面的异常是由什么到导致的. - No beans defined in application context ...
matlab不连接internet激活_MATLAB R2019b 完整激活教程
原标题:MATLAB R2019b 完整激活教程准备工作: 1.下载MATLAB R2019b安装包链接:https://www.macdu.org/24146.html 2.安装大概需要 26G ...

Gin-swagger完整使用教程

准备工作

进入正题

Gin-swagger完整使用教程相关推荐

最新文章

热门文章