一款比Postman還要好用的測試接口工具,竟然還能生成接口文檔?
本文轉(zhuǎn)載自微信公眾號「Java極客技術(shù)」,作者鴨血粉絲。轉(zhuǎn)載本文請聯(lián)系Java極客技術(shù)公眾號。
因為最近阿粉一直在做接口開發(fā),前后端分離的項目,阿粉在之前也看過關(guān)于swagger,但是阿粉沒有用,畢竟弄這個東西,還需要leader批示,加出問題來了,還容易背鍋,于是阿粉就開始找能夠快速生成接口文檔的工具,終于,阿粉成功找到了一個比postman還要好用的工具,即可以做接口的測試,還能生成接口文檔。
Run-Api
runapi是一個以接口為核心的開發(fā)測試工具(功能上類似一個簡化版的postman)。目前有客戶端版(推薦,支持win和mac平臺)和在線精簡版 ,包含接口測試/項目協(xié)作等功能。
它和showdoc( https://www.showdoc.com.cn/help)相輔相成:showdoc以文檔為核心,側(cè)重文檔編寫和知識資料沉淀。而runapi則以接口為核心,包含接口測試、管理等一系列功能。同時它將自動生成文檔到showdoc。
Run-Api怎么用
首先我們先下載這個軟件,
官網(wǎng),官方防止給大家放上了,大家可以去下載一下,我們現(xiàn)在就來看看他是怎么用的。
Run-Api接口測試
大家安裝完后就是這個樣子了,我們怎么去掉用接口呢?
先創(chuàng)建個默認的項目,然后給起一個比較酷炫的名字,
然后再這里選擇你想要把地址寫在哪個項目中,
大家看,是不是和postman的測試是一樣的,況且,postman你還需要去找指定版本,有時候還會導致你系統(tǒng)卡死,但是因為是公認的好用的,所以很多人都直接選擇使用postman,但是現(xiàn)在找到了更好的,大家是不是就可以開始換一下了?
假如你們的項目有增加安全機制,那么在請求的Headers中肯定也加入了一些必須要給的參數(shù),比如Token,如果你在每個接口里面都需要這個Token 的話,你還要給每個接口都加,那多麻煩,來配置個全局的參數(shù)變量吧,看下圖所示
大家進入官網(wǎng)之后,忽然看到了個本地/局域網(wǎng),這是個啥呢?
官網(wǎng)簡介:如果你是使用runapi客戶端(https://www.showdoc.cc/runapi),則會自動跨域,可以請求本地和局域網(wǎng)的接口,不需要用戶額外操作。但如果你是使用在線精簡版( http://runapi.showdoc.cc )則需要在API的服務(wù)器上設(shè)置允許跨域。在服務(wù)器返回API結(jié)果的時候,也順便返回三個允許跨域的http header,其結(jié)構(gòu)如下:
- Access-Control-Allow-Origin: *
- Access-Control-Allow-Credentials : true
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie
大家注意看,如果你直接使用在線版本,那么你需要關(guān)心這個,如果你像阿粉一樣,直接使用客戶端,那么恭喜你,這一步,你可以壓根就不用管,因為官網(wǎng)告訴我們了,他可以自己跨域,是不是很爽?
Run-Api如何生成接口文檔
我們把我們想要的信息都設(shè)置完成之后,然后點擊發(fā)送,等待結(jié)果出現(xiàn),這時候我們就要點擊保存了。
保存完成之后,它會根據(jù)你設(shè)置的入?yún)⑦€有出參,給你生成文檔,
上圖是入?yún)ⅲ臋n圖在這里,來了
同時它會給你一個密碼,只有你們兩個人知道呦,這樣我們就打開網(wǎng)址來看看,這個接口文檔是什么樣子的,有沒有大家想象中的那么簡單易懂。
入?yún)嵗?/p>
出參實例:
看是不是有點牛,而且樣子還是非常美觀的,也不需要去像Swagger一樣,去給方法里面加注解,而如果你對Swagger不是特別熟練,有時候還會忘記,但是這樣生成了,給前端的網(wǎng)址,然后讓他們自己去調(diào)用接口就可以了,是不是很爽,又安利了一款軟件。
如果大家需要,請在公眾號后臺回復runapi,連接地址發(fā)給大家,直接下載即可使用,你還在等什么呢?
對比postman
我們再來看看傳統(tǒng)的postman,英文比較多,
GET請求:點擊Params,輸入?yún)?shù)及value,可輸入多個,即時顯示在URL鏈接上, 所以,GET請求的請求頭與請求參數(shù)如在接口文檔中無特別聲明時,可以不填。
POST請求:傳遞參數(shù)params,Json格式的就行,然后再發(fā)送請求就可以,阿粉認為,畢竟很多人都在用postman,但是哪個好用,哪個不好用,這個還是分人,就比如有人喜歡牛奶,有人喜歡可樂,有人喜歡果汁一樣。
所以,選擇什么軟件,大家就用什么軟件,沒有必要強求不是,到現(xiàn)在阿粉公司都是IDEA和Eclipse共存,使用習慣不一樣,就是不一樣,所以,大家看著選擇吧。