簡述Gin框架整合swagger過程

2021-09-24 02:17:45 字數 1640 閱讀 4871

1、安裝swag

swag用於生成docs資料夾(swagger文件程式使用)

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

2、安裝依賴包

3、示例程式

package main

)// @title 測試

// @version 0.0.1

// @description 測試

// @basepath /api/v1/

func main()

// name will print hello name

// @summary print

// @accept json

// @tags name12

// @security bearer

// @produce json

// @param some_id path int true "userid"

// @resource name

// @router /record/ [get]

// @success 200 string "ok"

func record(c *gin.context)

注意:main方法上的@basepath /api/v1/record方法 上的@router /record/ [get]並不是像beego註解一樣用來當方法路由用的,而是swagger不能識別具體的哪個路由對應哪個方法,所以需要手動指定,供介面的try it out使用

其他引數:參考文件

4、生成文件

在專案執行swag init

執行go run main.go

進入檢視文件

目錄下 執行命令

swag init
自動生成 docs 資料夾,內含 swagger.json 、swagger.json 、 docs.go

編譯不通過,檢視報錯資訊,修改注釋。

匯入生成的 docs 檔案

即這個 ./docs

簡述 Gin 框架如何整合swagger

title 這個 api 所表達的含義,是乙個文字,空格之後的內容全部解析為 title description 這個 api 詳細的描述,是乙個文字,空格之後的內容全部解析為 description param 引數,表示需要傳遞到伺服器端的引數,有五列引數,使用空格或者 tab 分割,五個分別表...

簡述 Gin 框架如何整合swagger

1 安裝swag go get github.com swaggo swag cmd swagswag用於生成docs資料夾 swagger文件程式使用 安裝完成後會在 bin生成乙個執行檔案 2 安裝依賴包 3 示例程式一package main title 開發文件 version 0.0.1 ...

SpringBoot專案整合Swagger2

swagger 是最流行的 api 開發工具,它遵循 openapi specification openapi 規範,也簡稱 oas swagger 可以貫穿於整個 api 生態,如 api 的設計 編寫 api 文件 測試和部署。swagger 是一種通用的,和程式語言無關的 api 描述規範。...