1.安裝 swag

go get github.com/swaggo/swag/cmd/swag swag 用于生成 docs 文件夾(swagger文檔程序使用)安裝完成后會在 ${GOPATH}/bin生成一個執(zhí)行文件

2.編寫代碼

/*** Created by liuyusnhengsir on 23/01/2022*/package mainimport (_ "lys_gin_swag/docs""github.com/gin-gonic/gin"ginSwagger "github.com/swaggo/gin-swagger""github.com/swaggo/gin-swagger/swaggerFiles" )// @title lys_gin_swag微服務api // @version 0.0.1 // @description lys_gin_swag微服務 code by 劉云生 // @BasePath / func main() {r := gin.New()// 創(chuàng)建路由組v1 := r.Group("/api/v1")v1.GET("/sayHello/:name", sayHello)v2 := r.Group("/api/v2")v2.GET("/sayHello/:name", sayHello2)// 文檔界面訪問URL// http://127.0.0.1:8080/swagger/index.htmlr.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))r.Run(":8080") }// @sayHello // @Description sayHello // @Accept json // @Produce json // @Param name path string true "name" // @Success 200 {string} string "name,helloWorld" // @Router /api/v1/sayHello/{name} [get] func sayHello(c *gin.Context) {name := c.Param("name")c.JSON(200, gin.H{"describe": "this is /api/v1 ","name": name,}) }// @sayHello2 // @Description sayHello2 // @Accept json // @Produce json // @Param name path string true "name" // @Success 200 {string} string "name,helloWorld" // @Router /api/v2/sayHello/{name} [get] func sayHello2(c *gin.Context) {name := c.Param("name")c.JSON(200, gin.H{"describe": "this is /api/v2","action": name,}) }

3.swag init

執(zhí)行 swag init

4.運行效果

go run main.go

進入 http://127.0.0.1:8080/swagger/index.html 查看文檔

總結

以上是生活随笔為你收集整理的go集成gin+swagger的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內容還不錯，歡迎將生活随笔推薦給好友。