gin集成swagger構建api文檔

官方文檔

• gin-swagger
• swagger-doc

具體步驟如下：

安裝 swag

go get github.com/swaggo/swag/cmd/swag

一般安裝比較慢，這裏我先安裝了go mod 藉助https://goproxy.cn 代理，安裝很快。當然，你會科學上網也可以。

安裝gin-swagger

go get -u github.com/swaggo/gin-swagger

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

示例 main.go

package main

import (
	_ "demo/docs"
	"github.com/gin-gonic/gin"
	"github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
	"net/http"
)

func main() {

	r := gin.Default()
	r.POST("/login", login)
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	r.Run(":8282")
}


// @登錄
// @Description login
// @Accept  json
// @Produce json
// @Param   username     path    string     true        "username"
// @Param   passwd     path    string     true        "passwd"
// @Success 200 {string} string	"ok"
// @Router /login [post]
func login(c *gin.Context){
	username := c.PostForm("username")
	passwd := c.PostForm("passwd")
	c.String(http.StatusOK, "Hello world "+username+"_"+passwd)
}

生成文檔

在項目目錄執行

swag init

這個時候你會發現在項目目錄新建了一個docs目錄，包含docs.go、swagger.json、swagger.yaml

運行示例程序

go run main.go

查看接口文檔

進入 http://127.0.0.1:8282/swagger/index.html

資料來源

• 目錄