文章目錄
- Apipost :一款值得使用的利器
- 主角登場
- Postman vs apiPost
- swagger VS apipost
- swagger優點:
- swagger的缺點
- apipost對比:
- 總結
Apipost :一款值得使用的利器
主角登場
Apipost 是一個支援模拟POST、GET、PUT常見的HTTP請求,支援團隊協作,并可直接生成并導出接口文檔的API調試、管理工具。
你可以把這款利器看成這樣的組合:
Apipost = Postman + Swagger + Mock
Postman和Swagger大家應該都很熟悉了吧,Mock這邊小編和大家簡單介紹一下,Mock其實就是模拟接口所傳回參數的工具,友善快速幫助走完整體流程,在一些特殊的環境下,可以幫助我們進行程式調試。舉個例子,A公司和B公司,有合作關系,現在項目都已經上線了。然後B公司把他們的測試環境關閉了,但是A公司可能他内部需求調整需要使用B公司的測試環境來進行走程式流程。這個時候該怎麼辦呢? Mock就是一個很好的方式,A公司可以在Mock工具裡定義B公司程式所傳回的結果,這樣由之前調用B公司的測試位址,改成為調用Mock測試位址,進而達到模拟的效果,而今天推薦的Apipost就提供了Mock工具,詳細點小編在後面為大家詳細的講解。
整體上,我們認識Apipost它所具備的基本能力,那為什麼小編要給大家推薦這款?
小編公司剛好Postman、Swagger、Mock三個功能都有使用,三個功能,對應着三個産品,接口調試小編需要下載下傳Postman、使用Swagger對代碼有侵入性,而且Swagger最後顯示出來文檔效果着實不咋地、使用Mock需要額外去下載下傳一個Mock工具,進行私有化部署,占用伺服器資源、域名資源等等。
Apipost 就把這三點集中于一身,低成本做長期主義的事情,小編就分着三個次元,給大家講講Apipost它和其他産品對比的一個優勢。
Postman vs apiPost
Postman
簡介 Postman是Google開發的一款接口測試工具,提供功能強大的 Web API & HTTP 請求調試。它能夠發送任何類型的HTTP 請求 (GET, HEAD, POST, PUT…),附帶任何數量的參數+ headers支援不同的認證機制(basic, digest, OAuth),接收到的響應文法高亮(HTML,JSON或XML)。Postman 能夠保留了曆史的請求,這樣我們就可以很容易地重新發送請求,有一個“集合”功能,用于存儲所有請求相同的API/域
apipost
簡介 apiPost是一個支援團隊協作,并可直接生成文檔的API調試、管理工具
支援模拟POST、GET、PUT等常見請求,是一個國産的、跟Postman差不多的、用來測試Web API的軟體,提供window、mac、linux版本下載下傳,對于有在開發Web API的開發者相當有用,同時由于它是國産軟體,完全中文界面更加友好,也符合中國開發者的使用體驗。另外支援一鍵生成api接口文檔,省掉不少開發者的工作
swagger VS apipost
swagger優點:
- 一個檔案就是一個文檔
- 隻針對API,而不針對特定的語言的API,很多自動生成API的工具基本都是隻針對特定的API的
- 官網有直接的demo,甚至都可以不用自己搞一套伺服器
swagger的缺點
代碼侵入性太強、項目中需要依賴與業務無關的jar包、需要編寫大量與業務無關的注解和參數,增加開發成本,降低代碼可讀性
文檔的展示依賴于項目的部署啟動。不便于前端脫離後端進行接口調試,降低開發效率
不支援全局的接口文檔的統一管理和維護,沒有一個文檔中心
不支援mock資料,不便于前端調試複雜接口,影響前端開發效率及品質
不支援權限管理,對于接口文檔的通路沒有項目、角色、人員級别的權限管控
不支援測試人員進行接口自動化測試
不支援導出備份
添加文檔備注很不友善,需要更改源代碼,不能添加截圖備注/不适合添加大段的備注等
對于傳回結果不能添加說明或者實作這個功能非常麻煩。雖然 Swagger 有 @ApiResponse 注解用來說明傳回結果,但是這個使用并不友善,而且如果傳回的并不是對象的時候(如 Map),就無法實作給每一個傳回字段的說明。如果将所有的傳回結果都是用對象封裝,然後添加注解,這又是一個非常大的工作量
apipost對比:
一鍵快速生成文檔:接口文檔的撰寫非常麻煩,很多屬于重複工作,效率低下。接口參數填寫完畢後,隻要在 Apipost 按下“分享文檔”按鈕,就會一鍵自動生成漂亮、規範的文檔,并且可以自定義分享有效期及權限。
團隊成員間可實時協作:針對團隊成員間協作不同步,資料儲存有沖突,無法追溯變更記錄的情況,多人線上協作時,Apipost 支援資料實時同步,有沖突解決機制,并且可以追溯協作日志。
用戶端支援不登入使用:使用者處于區域網路環境時(或者公司對網絡限制嚴格),Apipost 用戶端支援不登入使用。
用戶端支援離線脫機使用:即使在拔掉網線的情況下,仍可以正常打開 Apipost 用戶端的進行大部分操作。
參數庫描述:很多接口往往具有大量相同名稱、相同意義的參數,每次手動重複錄入,非常耗時、低效。Apipost 通過自定義參數描述庫,可以将大量參數進行預注釋,并在輸入參數時支援自動填充描述,節省了我們不少重複錄入參數描述的時間。
Websocket測試功能:另外,全新Apipost6.1版本重點推出使用者屢次提到的Websocket測試功能。