golang使用swagger的過程詳解
更新時間：2024年06月06日 10:33:25 作者：lemonth
這篇文章主要介紹了golang使用swagger的過程詳解,本文給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧
1、安裝
go install github.com/swaggo/swag/cmd/swag@latest go get -u github.com/swaggo/gin-swagger go get -u github.com/swaggo/gin-swagger/swaggerFiles
2、生成swag文檔
命令：swag init
錯誤
'swag' 不是內(nèi)部或外部命令，也不是可運行的程序
或批處理文件。
go install github.com/swaggo/swag/cmd/swag@latest
需要安裝到bin環(huán)境變量
3、在main上添加
// @title Swagger Example API
// @version 1.0.0
// @description This is a sample Server pets
// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name x-token
// @BasePath /
func main() {4、 引入docs文檔
報錯 Fetch error Internal Server Error doc.json 是沒有引入docs
5、創(chuàng)建swagger路由
engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
6、再接口上添加注釋
// @Tags CheckApi
// @Summary 檢測測試
// @accept application/json
// @Produce application/json
// @Param data query request.Req true "查詢渠道"
// @Success 200 {string} string "{"success":true,"data":{},"msg":"查詢成功"}"
// @Router /router/addr [get]
6、success
到此這篇關(guān)于golang使用swagger的文章就介紹到這了,更多相關(guān)golang使用swagger內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Go語言中make和new函數(shù)的用法與區(qū)別
這篇文章介紹了Go語言中make和new函數(shù)的用法與區(qū)別，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-07-07
這篇文章主要介紹了在Golang中使用C語言代碼實例,本文先是給出了一個Hello World例子、Golang 引用 C例子,并總結(jié)了一些要注意的地方,需要的朋友可以參考下2014-10-10
Go語言是采用UTF8編碼的,理論上使用任何文本編輯器都能做Go語言開發(fā),下面這篇文章主要給大家介紹了關(guān)于使用VS?code快速搭建一個Golang項目的相關(guān)資料,文中通過圖文介紹的非常詳細,需要的朋友可以參考下2023-04-04
這篇文章主要介紹了golang分層測試之http接口測試入門教程，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-12-12
這篇文章主要介紹了淺談Golang是如何讀取文件內(nèi)容的，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-05-05
在?Go?語言中,切片拼接是一項常見的操作,但如果處理不當,可能會導(dǎo)致性能問題或意外的副作用,本文將詳細介紹幾種高效的切片拼接方法,希望對大家有所幫助2024-01-01
這篇文章主要介紹了Goland和IDEA換行符的設(shè)置方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
這篇文章主要給大家介紹了關(guān)于Golang如何自定義logrus日志保存為日志文件的相關(guān)資料,logrus是目前Github上star數(shù)量最多的日志庫,logrus功能強大,性能高效,而且具有高度靈活性,提供了自定義插件的功能,很多開源項目都是用了logrus來記錄其日志,需要的朋友可以參考下2024-02-02
go語言區(qū)塊鏈實戰(zhàn)實現(xiàn)簡單的區(qū)塊與區(qū)塊鏈
這篇文章主要為大家介紹了go語言區(qū)塊鏈的實戰(zhàn)學習，來實現(xiàn)簡單的區(qū)塊與區(qū)塊鏈示例過程，有需要的朋友可以借鑒參考下，希望能夠有所幫助2021-10-10
Gin是Golang目前最為常用的Web框架之一,公司項目驗收需要API接口設(shè)計說明書（Golang后端服務(wù)基于Gin框架編寫）,所以本文給大家介紹了Golang使用Swag搭建api文檔的全過程,需要的朋友可以參考下2024-02-02