Golang使用Gin框架整合Swagger生成api文档

• 一、环境介绍
• 二、开始整合
• 1、安装swagger
• 2、Gin router代码
• 3、api代码
• 4、生成api配置文档
• 5、访问swagger

一、环境介绍

Go版本：1.13.1
开发工具：IntelliJ IDEA 2019.2.3 x64
开发环境：windows 10 64位

二、开始整合

代码目录结构

1、安装swagger

IDEA Terminal 项目根目录执行

2、Gin router代码

重点注意两点：
import _ “modulename/docs”
router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

3、api代码

一定要注意在方法上添加的注释，如果不规范，swagger不会识别
标准注释参见
https://swaggo.github.io/swaggo.io/declarative_comments_format/general_api_info.html

4、生成api配置文档

IDEA Terminal 项目根目录执行

会在项目根目录生成docs文件夹，docs文件有三个文件

5、访问swagger

启动服务。IDEA Terminal 项目根目录执行

浏览器访问http://localhost:port/swagger/index.html