swagger簡(jiǎn)介

swagger是一個(gè)工具帆离,用于自動(dòng)生成web網(wǎng)站對(duì)外提供的服務(wù)接口文檔,并且以web頁面的形式進(jìn)行展示结澄。

那么我們?yōu)槭裁葱枰@個(gè)工具呢哥谷?這首先需要從web相關(guān)項(xiàng)目的開發(fā)模式說起。

web相關(guān)的項(xiàng)目麻献,可以分為服務(wù)端的開發(fā)和客戶的開發(fā)呼巷。客戶端的形式一般有html頁面赎瑰,android王悍,和其他一些形式。服務(wù)端提供webservice形式的接口餐曼,供客戶端進(jìn)行調(diào)用压储。

當(dāng)服務(wù)端的開發(fā)和客戶端的開發(fā)是由不同的團(tuán)隊(duì)完成的時(shí)候,需要兩個(gè)團(tuán)隊(duì)首先約定好接口的定義源譬。接口的定義一般是由開發(fā)服務(wù)端的團(tuán)隊(duì)來進(jìn)行集惋,把服務(wù)端提供的接口寫成文檔,交給客戶端的開發(fā)人員踩娘,讓他們按照文檔中接口的定義刮刑,來調(diào)用服務(wù)端的服務(wù)程序喉祭。

問題在于,服務(wù)端提供的接口并不能一次完成雷绢,它是在開發(fā)過程中不斷修改的泛烙。那么這就需要服務(wù)端的開發(fā)人員,在每次修改完接口之后翘紊,就要更新一次接口文檔蔽氨,然后把新版的文檔發(fā)給客戶端的開發(fā)人員,讓他們按照新版的文檔進(jìn)行使用帆疟。

如果這個(gè)中間的過程存在滯后鹉究,特別是服務(wù)端和客戶端的開發(fā)團(tuán)隊(duì)在兩個(gè)城市的時(shí)候,那么就特別容易帶來接口不匹配的問題踪宠。

swagger工具自赔,就是為了解決這個(gè)問題而開發(fā)的。它本身是一些jar包柳琢,使用的時(shí)候需要把這些jar包加到服務(wù)端程序的編譯路徑里匿级。服務(wù)接口的開發(fā)跟之前一樣,需要增加的內(nèi)容是染厅,在每個(gè)需要對(duì)外提供服務(wù)的接口的上面加上一些注解痘绎,形如@param等,加上這些注解之后肖粮,swagger工具就能自動(dòng)都把這些接口提取出來孤页,并以網(wǎng)站的形式對(duì)外展現(xiàn)。

除了能夠展現(xiàn)接口的定義之外涩馆,swagger工具還提供了對(duì)接口的單元測(cè)試功能行施,這個(gè)功能能夠幫助客戶端開發(fā)人員對(duì)接口的理解和使用。

使用swagger工具之后魂那,對(duì)于服務(wù)端的開發(fā)人員來講蛾号,就不需要再寫接口文檔了,他們只需要在對(duì)外服務(wù)接口上加上一些注解涯雅,就可以把這些接口展現(xiàn)給客戶端的開發(fā)人員鲜结。接口定義修改了的時(shí)候,只需要同步維護(hù)這些注解活逆,客戶端人員看到的接口就會(huì)同步更新精刷。因?yàn)榫S護(hù)這些注解是在代碼級(jí)的,服務(wù)端的開發(fā)人員在修改代碼的時(shí)候可以同步進(jìn)行修改蔗候,幾乎不耗費(fèi)額外的精力怒允。

而對(duì)于客戶端的開發(fā)人員來講,調(diào)用接口的時(shí)候锈遥,他們不需要再去查看接口文檔了纫事,而是直接查看由swagger工具提供的接口網(wǎng)站勘畔。這里提供的接口定義,比文檔里面的更加準(zhǔn)確丽惶,直接炫七,更新及時(shí)。

總而言之蚊夫,在web網(wǎng)站開發(fā)需要多團(tuán)隊(duì)協(xié)作的時(shí)候使用swagger工具,能夠有效降低不同團(tuán)隊(duì)之間有關(guān)的接口定義的溝通成本懦尝,提高團(tuán)隊(duì)的開發(fā)效率知纷。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市陵霉,隨后出現(xiàn)的幾起案子琅轧,更是在濱河造成了極大的恐慌,老刑警劉巖踊挠,帶你破解...
    沈念sama閱讀 222,627評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件乍桂,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡效床,警方通過查閱死者的電腦和手機(jī)睹酌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,180評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來剩檀,“玉大人憋沿,你說我怎么就攤上這事』铮” “怎么了辐啄?”我有些...
    開封第一講書人閱讀 169,346評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)运嗜。 經(jīng)常有香客問我壶辜,道長(zhǎng),這世上最難降的妖魔是什么担租? 我笑而不...
    開封第一講書人閱讀 60,097評(píng)論 1 300
  • 正文 為了忘掉前任砸民,我火速辦了婚禮,結(jié)果婚禮上奋救,老公的妹妹穿的比我還像新娘阱洪。我一直安慰自己,他們只是感情好菠镇,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,100評(píng)論 6 398
  • 文/花漫 我一把揭開白布冗荸。 她就那樣靜靜地躺著,像睡著了一般利耍。 火紅的嫁衣襯著肌膚如雪蚌本。 梳的紋絲不亂的頭發(fā)上盔粹,一...
    開封第一講書人閱讀 52,696評(píng)論 1 312
  • 那天,我揣著相機(jī)與錄音程癌,去河邊找鬼舷嗡。 笑死,一個(gè)胖子當(dāng)著我的面吹牛嵌莉,可吹牛的內(nèi)容都是我干的进萄。 我是一名探鬼主播,決...
    沈念sama閱讀 41,165評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼锐峭,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼中鼠!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起沿癞,我...
    開封第一講書人閱讀 40,108評(píng)論 0 277
  • 序言:老撾萬榮一對(duì)情侶失蹤援雇,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后椎扬,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體惫搏,經(jīng)...
    沈念sama閱讀 46,646評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,709評(píng)論 3 342
  • 正文 我和宋清朗相戀三年蚕涤,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了筐赔。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,861評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡揖铜,死狀恐怖川陆,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蛮位,我是刑警寧澤较沪,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布,位于F島的核電站失仁,受9級(jí)特大地震影響尸曼,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜萄焦,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,196評(píng)論 3 336
  • 文/蒙蒙 一控轿、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧拂封,春花似錦茬射、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,698評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至萧恕,卻和暖如春刚梭,著一層夾襖步出監(jiān)牢的瞬間肠阱,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,804評(píng)論 1 274
  • 我被黑心中介騙來泰國(guó)打工朴读, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留屹徘,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 49,287評(píng)論 3 379
  • 正文 我出身青樓衅金,卻偏偏與公主長(zhǎng)得像噪伊,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子氮唯,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,860評(píng)論 2 361

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

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,324評(píng)論 25 707
  • swagger 了解更多 一鉴吹、簡(jiǎn)介 Swagger是一種REST APIs的簡(jiǎn)單但強(qiáng)大的表示方式,標(biāo)準(zhǔn)的您觉,語言無關(guān)...
    阿琦zzz閱讀 4,691評(píng)論 1 0
  • Swagger 是一款RESTFUL接口的文檔在線自動(dòng)生成+功能測(cè)試功能軟件拙寡。本文簡(jiǎn)單介紹了在項(xiàng)目中集成swagg...
    GhostStories閱讀 2,666評(píng)論 2 13
  • 凌晨1點(diǎn)。藍(lán)喵輾轉(zhuǎn)難眠般堆。手機(jī)里那個(gè)熟悉的號(hào)碼在孝。撥通后又快速掛斷。到了一定的年紀(jì)淮摔。我們都會(huì)給自己找各種臺(tái)階私沮,厚重的盔...
    被狗叼走的棉花糖閱讀 169評(píng)論 0 0
  • 《同讀一本書 2016-06-01-074 》 (米婭快跑) 正文:"這樣淺顯的道理,做起來卻很難和橙,尤其對(duì)于那些...
    贠霞閱讀 248評(píng)論 0 0