快捷導(dǎo)航

Go語言Swagger實現(xiàn)為項目生成 API 文檔

更新時間：2025年03月24日 09:38:28 作者：codepzj

Swagger 是一個基于 OpenAPI 規(guī)范設(shè)計的工具,用于為 RESTful API 生成交互式文檔,下面小編就來介紹一下如何在 Go 項目中集成 Swagger,特別是結(jié)合 Gin 框架生成 API 文檔

安裝 Swagger

全局安裝 swag CLI

swag 是 Swagger 的命令行工具，用于生成 API 文檔?？梢酝ㄟ^以下命令全局安裝：

go get github.com/swaggo/swag/cmd/swag@latest
go install github.com/swaggo/swag/cmd/swag@latest

項目依賴安裝

在項目中需要安裝以下依賴以支持 Gin 和 Swagger 的集成：

go get github.com/swaggo/gin-swagger
go get github.com/swaggo/files
go get github.com/alecthomas/template

格式化 Swagger 注釋

使用 swag fmt 命令可以格式化項目中的 Swagger 注釋，確保注釋符合規(guī)范：

swag fmt

使用 swag CLI 生成文檔

運行以下命令生成 Swagger 文檔（默認(rèn)生成 docs.go、swagger.json 和 swagger.yaml 文件）：

swag init

swag init 常用選項

選項	說明	默認(rèn)值
--generalInfo, -g	指定包含通用 API 信息的 Go 文件路徑	main.go
--dir, -d	指定解析的目錄	./
--exclude	排除解析的目錄（多個目錄用逗號分隔）	空
--propertyStrategy, -p	結(jié)構(gòu)體字段命名規(guī)則（snakecase、camelcase、pascalcase）	camelcase
--output, -o	輸出文件目錄（swagger.json、swagger.yaml 和 docs.go）	./docs
--parseVendor	是否解析 vendor 目錄中的 Go 文件	否
--parseDependency	是否解析依賴目錄中的 Go 文件	否
--parseInternal	是否解析 internal 包中的 Go 文件	否
--instanceName	設(shè)置文檔實例名稱	swagger

示例：

swag init --dir ./ --output ./docs --propertyStrategy snakecase

Swagger 注釋格式

Swagger 使用聲明式注釋來定義 API 的元信息。以下是常用注釋及其說明：

通用 API 信息

通常在 main.go 中定義，用于描述整個 API 的基本信息：

// @title Swagger Example API
// @version 1.0
// @description This is a sample server celler server.
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:8080
// @BasePath /api/v1
// @schemes http https

API 路由注釋

在具體路由處理函數(shù)上方添加注釋，定義該接口的行為：

// GetPostById
// @Summary 獲取文章信息
// @Produce json
// @Param id path string true "文章ID"
// @Success 200 {object} Post "成功返回文章信息"
// @Failure 400 {string} string "請求參數(shù)錯誤"
// @Router /post/{id} [get]
func GetPostById(c *gin.Context) {
    // 函數(shù)實現(xiàn)
}

@Summary：接口簡述
@Produce：返回的 MIME 類型
@Param：參數(shù)定義（格式：名稱位置類型是否必填描述）
@Success：成功響應(yīng)（格式：狀態(tài)碼 {類型} 數(shù)據(jù)結(jié)構(gòu) 描述）
@Failure：失敗響應(yīng)
@Router：路由路徑和方法

示例項目代碼

以下是一個完整的示例，展示如何在 Gin 項目中集成 Swagger：

package main

import (
	"github.com/gin-gonic/gin"
	swaggerFiles "github.com/swaggo/files"
	ginSwagger "github.com/swaggo/gin-swagger"
	"strconv"
	_ "swagger/docs" // 導(dǎo)入生成的 Swagger 文檔
)

// Post 文章結(jié)構(gòu)體
type Post struct {
	ID          int64  `json:"id"`
	Title       string `json:"title"`
	Content     string `json:"content"`
	Description string `json:"description"`
}

func main() {
	r := gin.Default()
	r.GET("/post/:id", GetPostById)
	// 配置 Swagger 路由
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	r.Run(":8080")
}

// GetPostById 獲取文章信息
// @Summary 獲取文章信息
// @Produce json
// @Param id path string true "文章ID"
// @Success 200 {object} Post "成功返回文章信息"
// @Failure 400 {string} string "請求參數(shù)錯誤"
// @Router /post/{id} [get]
func GetPostById(c *gin.Context) {
	id, err := strconv.ParseInt(c.Param("id"), 10, 64)
	if err != nil {
		c.String(400, err.Error())
		return
	}
	c.JSON(200, Post{
		ID:          id,
		Title:       "codepzj",
		Content:     "測試",
		Description: "測試",
	})
}