Swagger界面丑毙玻、功能弱怎么破?用Postman增強下就給力了廊散!

在使用Swagger的時候桑滩,你是否會有這種感覺:提交參數(shù)為JSON沒法格式化,參數(shù)錯了查找麻煩允睹,返回結(jié)果沒法折疊运准,太長了沒法看!Swagger結(jié)合Postman使用后這一情況有很大改變缭受,今天我們來講下如何使用Postman增強Swagger的功能胁澳,希望對大家有所幫助!

Postman使用

Postman是一款非常好用的接口調(diào)試工具贯涎,界面漂亮且功能強大

Swagger結(jié)合Postman使用

下面介紹下如何將Swagger API導(dǎo)入到Postman中去听哭,然后使用Postman來調(diào)試接口。

Swagger API導(dǎo)入Postman

  • 首先我們需要啟動使用了Swagger的應(yīng)用項目塘雳,這里以之前的mall-tiny-swagger項目為例子陆盘,找到api-docs路徑,訪問地址:http://localhost:8088/swagger-ui/
image.png
  • 什么是Swagger的api-docs訪問路徑败明?該路徑會返回JSON格式數(shù)據(jù)隘马,應(yīng)用中Swagger渲染API文檔頁面的所有數(shù)據(jù)就是來源于此,Postman也是可以通過這些數(shù)據(jù)來渲染API文檔頁面妻顶,這里的api-docs地址為:http://localhost:8088/v2/api-docs

    image.png

  • 在postman中點擊import按鈕酸员,選擇Link蜒车,輸入Swagger的api-docs路徑即可將Swagger生成的接口導(dǎo)入到Postman中去了;

    image.png

  • 直接使用默認(rèn)選項導(dǎo)入即可幔嗦,無需修改酿愧;
    image.png
  • 導(dǎo)入成功后,Swagger中的接口就會出現(xiàn)在Postman中了邀泉,之后就只需要在Postman中改改參數(shù)就可以開始調(diào)試接口了嬉挡,是不是很方便!

    image.png

    Postman設(shè)置環(huán)境變量

  • 我們隨意找個接口訪問下汇恤,會發(fā)現(xiàn)訪問出錯了庞钢,那是因為baseUrl這個環(huán)境變量設(shè)置有問題,導(dǎo)致了接口無法訪問因谎;
    image.png
  • 我們只要在Postman中設(shè)置baseUrl這個環(huán)境變量基括,就可以正常訪問了;
    image.png
  • 添加好環(huán)境變量之后财岔,需要選擇好環(huán)境才會被應(yīng)用风皿。
    image.png

訪問需要登錄認(rèn)證的接口

  • 這時候再次訪問接口會發(fā)現(xiàn)我們的接口需要登錄認(rèn)證才能正常訪問;
    image.png
  • 我們可以先調(diào)用登錄接口來獲取Token使鹅;


    image.png
  • 給需要登錄認(rèn)證的接口添加Bearer Token類型的Token揪阶,我們可以發(fā)現(xiàn)需要配置一個叫token的環(huán)境變量;
    image.png
  • 在環(huán)境變量中添加token患朱;
    image.png
  • 添加完環(huán)境變量后即可正常訪問需要登錄認(rèn)證的接口了鲁僚。
    image.png

有何缺點

此種方法使用Postman來調(diào)試接口是非常強大的,但是對于文檔展示能力有點偏弱裁厅。

  • 比如說Swagger中的接口對于請求和返回參數(shù)都有非常完善的注釋信息冰沙;
    image.png
  • 而在Postman中,這些文檔信息得不到體現(xiàn)执虹,Postman畢竟還只是一個接口調(diào)試工具拓挥。
    image.png

總結(jié)

Swagger和Postman結(jié)合使用比較好,Swagger用來看接口文檔信息袋励,Postman用于調(diào)試侥啤,將Swagger中的接口導(dǎo)入到Postman中可以彌補Swagger在接口調(diào)試方面的不足。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末茬故,一起剝皮案震驚了整個濱河市盖灸,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌磺芭,老刑警劉巖赁炎,帶你破解...
    沈念sama閱讀 222,729評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異钾腺,居然都是意外死亡徙垫,警方通過查閱死者的電腦和手機讥裤,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,226評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來姻报,“玉大人己英,你說我怎么就攤上這事《阂郑” “怎么了剧辐?”我有些...
    開封第一講書人閱讀 169,461評論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長邮府。 經(jīng)常有香客問我,道長溉奕,這世上最難降的妖魔是什么褂傀? 我笑而不...
    開封第一講書人閱讀 60,135評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮加勤,結(jié)果婚禮上仙辟,老公的妹妹穿的比我還像新娘。我一直安慰自己鳄梅,他們只是感情好叠国,可當(dāng)我...
    茶點故事閱讀 69,130評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著戴尸,像睡著了一般粟焊。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上孙蒙,一...
    開封第一講書人閱讀 52,736評論 1 312
  • 那天项棠,我揣著相機與錄音,去河邊找鬼挎峦。 笑死香追,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的坦胶。 我是一名探鬼主播透典,決...
    沈念sama閱讀 41,179評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼顿苇!你這毒婦竟也來了峭咒?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,124評論 0 277
  • 序言:老撾萬榮一對情侶失蹤岖圈,失蹤者是張志新(化名)和其女友劉穎讹语,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蜂科,經(jīng)...
    沈念sama閱讀 46,657評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡顽决,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,723評論 3 342
  • 正文 我和宋清朗相戀三年短条,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片才菠。...
    茶點故事閱讀 40,872評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡茸时,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出赋访,到底是詐尸還是另有隱情可都,我是刑警寧澤,帶...
    沈念sama閱讀 36,533評論 5 351
  • 正文 年R本政府宣布蚓耽,位于F島的核電站渠牲,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏步悠。R本人自食惡果不足惜签杈,卻給世界環(huán)境...
    茶點故事閱讀 42,213評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望鼎兽。 院中可真熱鬧答姥,春花似錦、人聲如沸谚咬。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,700評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽择卦。三九已至敲长,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間互捌,已是汗流浹背潘明。 一陣腳步聲響...
    開封第一講書人閱讀 33,819評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留秕噪,地道東北人钳降。 一個月前我還...
    沈念sama閱讀 49,304評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像腌巾,于是被迫代替她去往敵國和親遂填。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,876評論 2 361

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