go使用swagger创建接口文档只看这个就够了

最新推荐文章于 2024-08-10 07:15:48 发布

smartaconf

最新推荐文章于 2024-08-10 07:15:48 发布

阅读量2k

点赞数

分类专栏：个人总结文章标签： golang 开发语言 swagger2

本文链接：https://blog.csdn.net/weixin_45919793/article/details/122845803

版权

个人总结专栏收录该内容

23 篇文章 0 订阅

订阅专栏

流程

下载依赖->添加注释->导入依赖->设置路由->执行初始化命令：swag init-> main函数所在.go导入新生成的包docs->再次执行初始化命令：swag init->打开swagger网页

下载并使用依赖

下载依赖

go get -u github.com/swaggo/swag/cmd/swag
go get github.com/swaggo/gin-swagger
go get github.com/swaggo/gin-swagger/swaggerFiles

使用依赖

ginSwagger “github.com/swaggo/gin-swagger”
“github.com/swaggo/gin-swagger/swaggerFiles”

在这里插入图片描述
注意：ginSwagger 给依赖包起的别名也可以用别的但是下面要一块改

添加注释

添加注释main.go中添加注释 在这里插入图片描述
给API接口添加注释
下面会详细介绍 api常用注释的用法

再主函数中设置swagger路由

r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

在这里插入图片描述

执行初始化命令 swag init 生成 docs文件夹

在这里插入图片描述

导入docs包

再次使用命令初始化swagger文档

swag init

在这里插入图片描述

浏览器地址栏输入

localhost:8080/swagger/index,html
端口号要和你自己设置的相同

在这里插入图片描述

// testAPI
// @Summary 测试testAPI --> 简介
// @Description -->对API的描述
// @Tags 测试 --> API分组
// @Accept json --> API接受的类型 支持参数 （只有两种类型）：json/mpfd  --->只接受json/表单类型 别的类型不接收，但是如果不写这个便签 就没有约束了
// @Param who query string true "人名"  ---> 要求前端传过来的数据 ----> who:参数名（自己定义） query：参数类型 主要有5种 类型1 query ---> query 该类型参数一般是组合在URL中的
// @Param id path integer true "文件id"  --->参数类型2 :path 该类型参数直接拼接在URL中
// @Param username formData string ture "账号名" default(admin) ---> 参数类型3 :formData 一般是POST、PUT方法所用
// @Param param body main.JSONParam true "上传的JSON" ---> body
// @Success 200 {string} string "{"msg": "hello Razeen"}"
// @Failure 400 {string} string "{"msg": "who are you"}"
// @Router /hello [get]
func testAPI(c *gin.Context) {

}