簡述 Gin 框架如何整合swagger

2022-01-29 13:32:11 字數 867 閱讀 3955

@title

這個 api 所表達的含義,是乙個文字,空格之後的內容全部解析為 title

@description

這個 api 詳細的描述,是乙個文字,空格之後的內容全部解析為 description

@param

引數,表示需要傳遞到伺服器端的引數,有五列引數,使用空格或者 tab 分割,五個分別表示的含義如下

1.引數名

2.引數型別,可以有的值是 formdata、query、path、body、header,formdata 表示是 post 請求的資料,query 表示帶在 url 之後的引數,path 表示請求路徑上得引數,例如上面例子裡面的 key,body 表示是乙個 raw 資料請求,header 表示帶在 header 資訊中得引數。

3.引數型別

4.是否必須

5.注釋

@success

成功返回給客戶端的資訊,三個引數,第乙個是 status code。第二個引數是返回的型別,必須使用 {} 包含,第三個是返回的物件或者字串資訊,如果是 型別,那麼 bee 工具在生成 docs 的時候會掃瞄對應的物件,這裡填寫的是想對你專案的目錄名和物件,例如 models.zdtproduct.productlist 就表示 /models/zdtproduct 目錄下的 productlist 物件。

三個引數必須通過空格分隔

failure

失敗返回的資訊,包含兩個引數,使用空格分隔,第乙個表示 status code,第二個表示錯誤資訊

@router

路由資訊,包含兩個引數,使用空格分隔,第乙個是請求的路由位址,支援正則和自定義路由,和之前的路由規則一樣,第二個引數是支援的請求方法,放在 之中,如果有多個方法,那麼使用 , 分隔。

簡述 Gin 框架如何整合swagger

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

簡述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...