一款比 postman 還要好用的測試接口工具,竟然還能生成接口文檔?

因爲最近阿粉一直在做接口開發,前後端分離的項目,阿粉在之前也看過關於 swagger,但是阿粉沒有用,畢竟弄這個東西,還需要 leader 批示,加出問題來了,還容易背鍋,於是阿粉就開始找能夠快速生成接口文檔的工具,終於,阿粉成功找到了一個比 postman 還要好用的工具,即可以做接口的測試,還能生成接口文檔。

Run-Api

runapi 是一個以接口爲核心的開發測試工具(功能上類似一個簡化版的 postman)。目前有客戶端版 (推薦,支持 win 和 mac 平臺)和在線精簡版 ,包含接口測試 / 項目協作等功能。

它和 showdoc(https://www.showdoc.com.cn/help) 相輔相成:showdoc 以文檔爲核心,側重文檔編寫和知識資料沉澱。而 runapi 則以接口爲核心,包含接口測試、管理等一系列功能。同時它將自動生成文檔到 showdoc。

Run-Api 怎麼用

首先我們先下載這個軟件,

官網,官方防止給大家放上了,大家可以去下載一下,我們現在就來看看他是怎麼用的。

Run-Api 接口測試

大家安裝完後就是這個樣子了,我們怎麼去掉用接口呢?

先創建個默認的項目,然後給起一個比較酷炫的名字,

然後再這裏選擇你想要把地址寫在哪個項目中,

大家看,是不是和 postman 的測試是一樣的,況且,postman 你還需要去找指定版本,有時候還會導致你係統卡死,但是因爲是公認的好用的,所以很多人都直接選擇使用 postman,但是現在找到了更好的,大家是不是就可以開始換一下了?

假如你們的項目有增加安全機制,那麼在請求的 Headers 中肯定也加入了一些必須要給的參數,比如 Token,如果你在每個接口裏面都需要這個 Token 的話,你還要給每個接口都加,那多麻煩,來配置個全局的參數變量吧,看下圖所示

大家進入官網之後,忽然看到了個本地 / 局域網,這是個啥呢?

官網簡介:如果你是使用 runapi 客戶端(https://www.showdoc.cc/runapi), 則會自動跨域,可以請求本地和局域網的接口,不需要用戶額外操作。但如果你是使用在線精簡版( http://runapi.showdoc.cc )則需要在 API 的服務器上設置允許跨域。在服務器返回 API 結果的時候,也順便返回三個允許跨域的 http header,其結構如下:

Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials : true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie

大家注意看,如果你直接使用在線版本,那麼你需要關心這個,如果你像阿粉一樣,直接使用客戶端,那麼恭喜你,這一步,你可以壓根就不用管,因爲官網告訴我們了,他可以自己跨域,是不是很爽?

Run-Api 如何生成接口文檔

我們把我們想要的信息都設置完成之後,然後點擊發送,等待結果出現,這時候我們就要點擊保存了。

保存完成之後,它會根據你設置的入參還有出參,給你生成文檔,

上圖是入參,文檔圖在這裏,來了

同時它會給你一個密碼,只有你們兩個人知道呦,這樣我們就打開網址來看看,這個接口文檔是什麼樣子的,有沒有大家想象中的那麼簡單易懂。

入參實例:

出參實例:

看是不是有點牛,而且樣子還是非常美觀的,也不需要去像 Swagger 一樣,去給方法裏面加註解,而如果你對 Swagger 不是特別熟練,有時候還會忘記,但是這樣生成了,給前端的網址,然後讓他們自己去調用接口就可以了,是不是很爽,又安利了一款軟件。

如果大家需要,請在公衆號後臺回覆 runapi,連接地址發給大家,直接下載即可使用,你還在等什麼呢?

對比 postman

我們再來看看傳統的 postman,英文比較多,

GET 請求:點擊 Params,輸入參數及 value,可輸入多個,即時顯示在 URL 鏈接上, 所以,GET 請求的請求頭與請求參數如在接口文檔中無特別聲明時,可以不填。

POST 請求:傳遞參數 params,Json 格式的就行,然後再發送請求就可以,阿粉認爲,畢竟很多人都在用 postman,但是哪個好用,哪個不好用,這個還是分人,就比如有人喜歡牛奶,有人喜歡可樂,有人喜歡果汁一樣。

所以,選擇什麼軟件,大家就用什麼軟件,沒有必要強求不是,到現在阿粉公司都是 IDEA 和 Eclipse 共存,使用習慣不一樣,就是不一樣,所以,大家看着選擇吧。

本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s/j-rLX4BRrK7iohB9urYxQA