【golang】接口文檔工具swagger使用

安裝swagger

此處只針對win敛惊,其他系統(tǒng)安裝方法可至官網(wǎng)查看弦悉。

go get github.com/go-swagger/go-swagger

//如果install出現(xiàn)pakage找不到富玷,進行g(shù)o get github.com/go-swagger/go-swagger/cmd/swagger即可
go install github.com/go-swagger/go-swagger/cmd/swagger

生成json文檔注釋文件

在定義接口方法之前加入swagger注釋

// swagger:operation POST /machine/{type} machine createmachine
// ---
// summary: List the repositories owned by the given author.
// description: If author length is between 6 and 8, Error Not Found (404) will be returned.
// parameters:
// - name: author
//   in: path
//   description: username of author
//   type: string
//   required: true
func Test(w http.ResponseWriter, r *http.Request) {
    .....
}

然后執(zhí)行生成文檔json命令

swagger generate spec -o ./swagger.json

此命令會找到main.go入口文件耘斩,然后遍歷所有源碼文件磁携,解析然后生成swagger.json文件

把文檔文件變?yōu)榭梢暬疷I

  • 從 swagger-ui庫下載dist文件夾到自己的項目中酌摇,并更名為swagger。把swagger中的index.html的url改成./swagger.json

  • 將生成的swagger.json作為一個fileServer路由加入到server中

//component/swagger為dist的目錄
httpMux.Handle("/swagger/", http.StripPrefix("/swagger/", http.FileServer(http.Dir("component/swagger"))))

最后訪問相應(yīng)路徑即可http://x.x.x.x:xxxx/swagger/index.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末驰坊,一起剝皮案震驚了整個濱河市匾二,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌拳芙,老刑警劉巖察藐,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異舟扎,居然都是意外死亡分飞,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門睹限,熙熙樓的掌柜王于貴愁眉苦臉地迎上來譬猫,“玉大人,你說我怎么就攤上這事羡疗∪痉” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵顺囊,是天一觀的道長肌索。 經(jīng)常有香客問我蕉拢,道長特碳,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任晕换,我火速辦了婚禮午乓,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘闸准。我一直安慰自己益愈,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布夷家。 她就那樣靜靜地躺著蒸其,像睡著了一般。 火紅的嫁衣襯著肌膚如雪库快。 梳的紋絲不亂的頭發(fā)上摸袁,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天,我揣著相機與錄音义屏,去河邊找鬼靠汁。 笑死蜂大,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蝶怔。 我是一名探鬼主播奶浦,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼踢星!你這毒婦竟也來了澳叉?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤沐悦,失蹤者是張志新(化名)和其女友劉穎耳高,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體所踊,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡泌枪,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了秕岛。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片碌燕。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖继薛,靈堂內(nèi)的尸體忽然破棺而出修壕,到底是詐尸還是另有隱情,我是刑警寧澤遏考,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布慈鸠,位于F島的核電站,受9級特大地震影響灌具,放射性物質(zhì)發(fā)生泄漏青团。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一咖楣、第九天 我趴在偏房一處隱蔽的房頂上張望督笆。 院中可真熱鬧,春花似錦诱贿、人聲如沸娃肿。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽料扰。三九已至,卻和暖如春焙蹭,著一層夾襖步出監(jiān)牢的瞬間晒杈,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工壳嚎, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留桐智,地道東北人末早。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像说庭,于是被迫代替她去往敵國和親然磷。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容