标签：200 swag name API go gin swagger com

##使用 swagger 日志服务

go get -u github.com/swaggo/swag/cmd/swag
swag init  // 要和main.go处于同一级目录


编辑

initialize/router.go

引入包

swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"

在Routers := gin.Default()下面增加

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

swag init  // 要和main.go处于同一级目录

make tidy

swagger 书写格式

日常书写注释的格式

// @Summary 接口概要说明
// @Description 接口详细描述信息
// @Tags 用户信息   //swagger API分类标签, 同一个tag为一组
// @accept json  //浏览器可处理数据类型，浏览器默认发 Accept: */*
// @Produce  json  //设置返回数据的类型和编码
// @Param id path int true "ID"    //url参数：（name；参数类型[query(?id=),path(/123)]；数据类型；required；参数描述）
// @Param name query string false "name"
// @Success 200 {object} Res {"code":200,"data":null,"msg":""}  //成功返回的数据结构， 最后是示例
// @Failure 400 {object} Res {"code":200,"data":null,"msg":""}
// @Router /test/{id} [get]    //路由信息，一定要写上

项目启动后
可访问地址查看Api文档
http://127.0.0.1:18001/swagger/index.html#/

标签：200,swag,name,API,go,gin,swagger,com
来源： https://blog.csdn.net/qq_35786954/article/details/122338719

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。