@
目录写在前面
gin swagger
安装依赖
go install github.com/swaggo/swag/cmd/swag@latest
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files
添加注释
// @BasePath /api/v1
// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK,"helloworld")
}
生成 api 文件
swag init
路由设置
package main
import (
"github.com/gin-gonic/gin"
docs "github.com/your-self-go-project-name/docs" // 注意这个 docs 目录需要填写你自己项目的真实路径
swaggerfiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
"net/http"
)
func main() {
r := gin.Default()
docs.SwaggerInfo.BasePath = "/api/v1" // api 文件路径
v1 := r.Group("/api/v1")
{
eg := v1.Group("/example")
{
eg.GET("/helloworld",Helloworld)
}
}
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.Run(":8080")
}
访问
http://host:port/sagger/index.html
源码分析
gin-swagger
参考资料
基础/标准库/第三方库
golang 导航
编程规范
算法｜面试
项目
标签：swag,github,golang,go,gin,swagger,com From： https://www.cnblogs.com/nones/p/18126252