簡述 Gin 框架如何整合swagger

1、安裝swag

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

安裝完成後會在$/bin生成乙個執行檔案

2、安裝依賴包

3、示例程式一

package main

)// @title 開發文件
// @version 0.0.1
// @basepath /api/v1/
// @title  haimait.com開發文件
// @version 1.0
// @description  golang api of demo
// @termsofservice haimait.com
// @contact.name api support
// @contact.url haimait.com
// @contact.email ×××@qq.com
// @basepath /api/v1/
func main() 
// 建立路由組
v1 := r.group("/api/v1")
v1.get("/getuser/:id", getuser)
r.run()
}// @tags 測試
// @summary  獲取指定getuser記錄1
// @description 獲取指定getuser記錄2
// @param authorization	header string true "bearer 31a165baebe6dec616b1f8f3207b4273"
// @accept  json
// @product json
// @param   id     query    int     true        "使用者id"
// @param   name   query    string  false        "使用者name"
// @success 200  string	""
// @router /getuser/:id [get]
func getuser(c *gin.context) 
type req struct 

在專案執行swag init

執行go run main.go

進入檢視文件

這些注釋字段，我們乙個個解釋。

如果你的程式中使用了token中間鍵，只需要新增下面兩行注釋即可

// @security x-token

// @param x-token header string true "authorization"

type req struct 

// @summary  獲取指定record記錄1
// @description 獲取指定record記錄2
// @tags 測試
// @accept  json
// @product json
// @param data body req true "請示引數data"
// @title 應用中心操作日誌
// @author [email protected]
// @description 獲取應用中心操作日誌
// @tags operationlog
// @param authorization	header string true "bearer 31a165baebe6dec616b1f8f3207b4273"
// @param route formdata string false "路由"
// @param operator formdata string false "操作者"
// @param operation_type formdata string false "操作型別 1 新增、2 刪除、3 更新"
// @param description formdata string false "操作描述"
// @param start_time formdata int64 false "開始時間"
// @param end_time formdata int64 false "結束時間"
// @param page formdata int true "頁數"
// @param size formdata int true "資料條數"
// @title 新增模版
// @author [email protected]
// @description 新增模版
// @tags release template
// @param authorization	header	string true "bearer 31a165baebe6dec616b1f8f3207b4273"
// @param body body	templateaddbody true "json資料"
api 注釋定義
官網文件：
其他/swagger.html
				
簡述 Gin 框架如何整合swagger
title 這個 api 所表達的含義，是乙個文字，空格之後的內容全部解析為 title description 這個 api 詳細的描述，是乙個文字，空格之後的內容全部解析為 description param 引數，表示需要傳遞到伺服器端的引數，有五列引數，使用空格或者 tab 分割，五個分別表...
				
簡述Gin框架整合swagger過程
1 安裝swag swag用於生成docs資料夾 swagger文件程式使用 安裝完成後會在 bin生成乙個執行檔案 2 安裝依賴包 3 示例程式package main title 測試 version 0.0.1 description 測試 basepath api v1 func main ...
				
go語言框架gin之整合swagger
1 安裝swag 在goland中直接使用go get u github.com swaggo swag cmd swag命令安裝會報錯 此時執行swag v命令判斷是否安裝成功，會返回以下錯誤 2 go install 進入gopath下src github.com swaggo swag cmd...