GO项目集成swagger

本文档详细介绍了如何使用Swaggo库为Gin框架的Go项目生成和配置Swagger API文档。步骤包括下载和安装Swaggo,试用命令生成docs文件夹,配置Swagger文件,编写API路由和注释,最后启动项目访问Swagger UI。

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

  • 第一步下载包
go get -u github.com/swaggo/swag/cmd/swag
  •  第二步安装swag的程序
go install github.com/swaggo/swag/cmd/swag

安装完会在你配置的GOPATH录下的bin下生成一个swag.exe

  •  第三步试用命令会在你的项目目录下生成docs文件夹
    swag init
  •  第四步配置swagger需要的文件  
    注意:_ "gin_gorm_jwt_demo/docs"  这个路径为你的项目名称 加上docs文件夹

import (
	"gin_gorm_jwt_demo/service"
	"github.com/gin-gonic/gin"
)
import (
	_ "gin_gorm_jwt_demo/docs"
	swaggerfiles "github.com/swaggo/files"
	ginSwagger "github.com/swaggo/gin-swagger"
)

func Router() *gin.Engine {
	r := gin.Default()
	// Swagger 配置
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
	r.GET("/test", service.Test)
	r.GET("/example/helloworld", service.Helloworld)
	r.GET("/example/helloworld2", service.Helloworld2)
	return r
}
  •  第五步 写配置文件
// 描述
// @Summary  这也是描述
// 一个大类别的名称
// @Tags  标题2
// 接受类型
// @Accept json
// 返回类型
// @Produce json
// 成功返回200  返回的类型
// @Success 200 {string} Helloworld
// 路由地址
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
	g.JSON(http.StatusOK, "helloworld")
}

 这就配置完了    然后每次修改配置文件的话 重写执行swag init  生成新的swagger文档

启动项目访问  http://localhost:8080/swagger/index.html

 

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值