go實踐之swagger自動生成api文件

2022-04-04 16:18:26 字數 2775 閱讀 2405

作為乙個後端開發,給前端提供api介面是必須的。手動去寫文件不是乙個程式設計師的風格。swagger就是乙個很好的api文件生成該工具,go當然也支援了。下面看看怎麼使用這個工具。

安裝gin-swagger,用來整合到我們前一篇文章go實踐之apiserver搭建實現的apiserver當中去。

在route生成的地方增加swagger的handler

rg.get("/docs/*any", ginswagger.wraphandler(swaggerfiles.handler))
在api處根據api新增描述

// @summary 獲取所有使用者

}// @summary 獲取單個使用者

}在mian函式出新增描述

// @title go-site example api

// @version 1.0

// @description this is a sample server petstore server.

// @termsofservice

// @contact.name api support

// @contact.url

// @contact.email [email protected]

// @license.name apache 2.0

// @license.url

// @host 127.0.0.1

// @basepath ""

func

main()

在專案的根目錄:windows下執行swag.exe init,linux下執行swag init執行完成之後會生成docs目錄,裡面含有自動生成的文件。

瀏覽器輸入訪問url:就可以開啟頁面了。

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

Go微服務實踐之增刪改查

從此篇文章開始,我們來陸續介紹go zero開發乙個專案所需要的元件和開發實踐。首先我們從model層開始,來說說go zero的api以及封裝細節。首先model層連線的api集中在core stores。我們先來看看操作mysql這類資料庫,api方法我們來到core stores sqlx,所...

Go微服務實踐之增刪改查

從此篇文章開始,我們來陸續介紹go zero開發乙個專案所需要的元件和開發實踐。首先我們從model層開始,來說說go zero的api以及封裝細節。首先model層連線的api集中在core stores。我們先來看看操作mysql這類資料庫,api方法我們來到core stores sqlx,所...