在使用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/
-
什么是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)試方面的不足。