比Postman更適合國人的介面除錯工具
介面除錯,是我們每個後臺開發,在日常工作中必不可少的一步,一個好的工具能讓我們的開發效率事半功倍。相信不少的小夥伴跟我一樣再進行API除錯時一直在使用Postman。它的介面除錯功能雖然強大,但是諸多研發常用功能並不符合國人習慣(如:生成介面文件等)。雖然支援協同功能,但幾乎是天價,同時由於伺服器在國外,經常出現延遲甚至卡頓的情況,十分不穩定。
前段時間在北京出差的過程中,有個同做後臺的開發的同事看到我在用Postman“轟”介面,他開玩笑的說了句 “什麼年代了還用Postman”,成功勾起了我的好奇心,通過了解我知道了一款國產API除錯工具ApiPost。
那麼今天博主就帶領大家從0到1(所謂的0到1就是從下載安裝到上手)客觀的測評一下我們國人自已開發的API除錯工具。
什麼是ApiPost
ApiPost = 介面除錯+介面文件快速生成+介面文件規範化管理+Mock API+介面流程測試。
ApiPost產生的初衷是為了提高研發團隊各個角色的效率!產品的使用受眾為由前端開發、後端開發和測試人員以及技術經理組成的整個研發技術團隊。ApiPost通過協作功能將研發團隊的每個角色整合打通。
- 官網地址:https://www.apipost.cn?token=aa1116507a26160f8889861932e51455
- Web版地址:https://console.apipost.cn/register?token=aa1116507a26160f8889861932e51455
- 客戶端下載連結:https://www.apipost.cn/download.html?token=aa1116507a26160f8889861932e51455
注:ApiPost在使用時可以選擇Web版(線上使用)與客戶端版(需下載),本文為了更好的進行測評僅為大家演示客戶端版的幾個常用操作使用流程。
下載安裝客戶端
點選上方客戶端下載地址進行跳轉,也可以進入官網進行下載。下載時根據自身電腦的配置選擇即可。
下載完成後選擇自已對應的路徑進行安裝
安裝完成後展現給我們的就是一個這麼一個控制檯,主題採用白字黑底配色,大致的功能已經給我們列出在首頁了,下面我帶領大家體驗一下。
測評一:系統頁面
不知道大家是否跟我一樣,下載好一個東西都喜歡配置一些個性化的設定,對於一個頁面整潔功能展示清晰的系統會比較有好感。下面我們來看下ApiPost這方面做得怎麼樣。
首先開啟的時候是深色模式,右下角是一些個性化設定,對應的功能有,精簡模式,控制檯,上下分屏,新視窗開啟響應區,模式調節,縮放,設定以及檢查更新功能。
左側列表,為專案目錄,可以將不同的介面放入不同的包中,右側的控制檯佔螢幕的5/4。整個為介面的除錯區,整個排版清晰得體。這塊做的真心挺不錯的。
最左側為七個主要的大功能頁籤,通過切換頁籤實現不同的功能。
正上方則是一些全域性引數,常用Cookie,環境的變數的配置與使用。
剩下的這兩塊就是關於團隊相關的了,平常自已用的話,完全可以不登入使用,但是如果整個團隊使用時就需要進行登入了,後面我們會詳細講解,這裡左側圈中的為切換團隊選項卡,右側圈中的為日誌,個人資訊,同步協作,系統訊息等相關功能。
測評一總結:系統的整個排版,顏色搭配,整體來說還是比較不錯的,相比postman來說,我們的ApiPost沒有很多多餘的功能,很適合我們國人理解去使用。
測評二:基礎功能
我們在使用這類軟體的時候,歸根結底就是為了對寫好的介面進行測試。其他的功能都是附加功能,第二項我們來測評一下ApiPost的基礎功能。
這裡ApiPost為了讓我們更好的上手,給我們提供一組示例介面。
點選介面後,右側會彈出該介面的詳資訊,主要看下圖中的幾點,我們在新建一個介面的時候可以宣告該介面是否開發成功,並可以對該介面進行一些說明,這些說明成功儲存後也都會在下圖中展示出來。
點擊發送按鈕後,我們可以清楚的再下面看到一些響應資訊(包含:請求頭,響應頭,cookie…等)也可以以不同的形式去展現響應結果。為了方便我們看介面的效能右下角還為我們展示了響應碼,以及介面的響應時間等等。
為了方便我們去看響應,還可以使用上文中提到的,新視窗開啟響應區功能。
值得注意的是這裡,這裡彈出的時候,需要再次點擊發送後才能看到
測評二總結: 這裡我們只發送了一個請求進行演示,並沒有做過多的操作是因為這些基本的操作(如:刪除介面,新增一個介面等等),所有的工具基本的流程都是一致的,只要掌握了一個其它的都沒太多問題。如果這些操作都不能理解,那也沒關係ApiPost還為我們提供了一份詳細的使用文件以及視訊教程
小夥伴們可以通過我上文中貼出來的官網連結進行訪問學習。如果連這麼詳細的文件和視訊都看不懂,也沒關係。我們Apipost還為小夥伴們提供了問答社群以及部落格。
這一點說真的,Apipost做的還是挺讚的!當然所有的東西都沒有絕對完美,在測試使用的過程中,我也發現,當我們使用新視窗開啟響應區的時候,不能把當前請求的響應結果繫結到新的視窗上,視窗也不能居中顯示,我有一瞬間還以為自已的操作有問題呢。這裡是個可優化的點,這也僅是我的個人意見,希望官方未來能給我們使用者帶來更好的體驗!
測評三:亮點功能
每個系統都會有自已的特色,通過官網的資訊我們瞭解到,ApiPost的特色功能大致為,文件分享,多人實時協作,客戶端不登入使用,離線工作,引數庫描述,Websocket測試等。
生成文件
文件是我們介面除錯後需要開發人員編寫的,這也是最令人頭疼的事情之一,ApiPost也剛好為我們解決了這個問題, 尤其對於很多介面來說,假如每次都需要手動錄入,將會是一件非常耗時、低效的事情。
假如我們想把上方測試的介面寫成到介面文件中,我們就可以使用ApiPost的一鍵文件生成功能。
生成時我們可以只針對一個包乃至一個專案為單位進行分享檢視
生成的文件相對我們平常自已寫的文件來說還是更規範一些,完美避開了我們日常寫錯引數,大小寫等問題,並且在分享的過程中還可以定義有效時間以及許可權控制。團隊中的前端人員也可以根據該文件去進行聯調,完全省去了開發人員自已編寫文件以及引用swagger等生成文件的框架等繁瑣步驟。最最重要的一點是他特別特別的方便。不知道大家有沒有發現在描述別的功能的時候總是進行很多操作,描述文件的時候他的整個過程十分簡單,真真正正的實現了一鍵匯出即使用!
實時協作
實時協作作為該平臺的另一亮點之。一個專案組中包含了產品,測試,前端,後端,運維。ApiPost開發這個功能的核心本質就是針對團隊打造的。
所有人都可以以專案組員的身份通過郵箱邀請,加入進來。由專案經理統一授權管理。
在對產品經理,測試,運維等,不需要涉及開發的人員可以設定只讀許可權,針對我們前後端開發,我們所做的每一步操作,在我們ApiPost中都可以做到實時更新(比如我在專案中新建了一個介面另外的同時哪裡立馬就會進行同步)。這樣可以有效的解決協作不同步時帶來的資料儲存衝突問題。另外我們ApiPost還會實時對你的操作進行記錄,無法追溯變更記錄等問題。在我們ApiPost中都是不存在的。(下圖為我在別人工程裡面新建了一個包他那邊立馬就進行了同步了)
引數庫描述
引數庫描述是配合我們基礎除錯功能使用的,很多介面往往具有大量相同名稱、相同意義的引數。就拿我們最常用的page,token來說。假如我們需要查詢一個列表是不是需要傳一些分頁引數,再比如我們需要獲取到當前的登入使用者,我們就需要傳一個token。這些引數往往在很多地方都有使用。我們就可以如下圖一樣把他定義為全域性的Header或全域性Body在輸入引數時ApiPost還支援自動填充描述。這樣以來我們就不用每次使用都要重新編寫!節省了我們不少重複錄入引數描述的時間。
離線使用
相信做開發的小夥伴有不少在政府部門,或是在一些相對機密的公司進行辦公。他們往往都需要使用區域網開發。ApiPost也發現了這一點,所以我們在測試的過程中特地關閉了網路連線。
經過測試,ApiPost的絕大部分功能都可以再不登陸的情況下完成。即使你的電腦連網路都沒有依舊不會造成太大的影響。
總結
整體的基礎功能測試基本完成了,一篇兩篇文章很難描述一個東西的好,只有大家自已安利使用了,才能知道這個東西適合不適合自已。在我看來ApiPost作為後起之秀,目前的基本功能都做的挺不錯的(在這我只做了部分測試大家下去可以自行體會)也正如官網所說,他是更懂中國人的平臺。未來還有很多可發展的空間,大家可以跟我一起見證ApiPost的崛起。