作為壹個前後端分離模式開發的團隊,我們經常會看到這樣的場景:前端開發和後端開發在壹起熱烈的討論“妳這接口參數怎麽又變了?”,“接口怎麽又不通了?”,“稍等,我調試下”,“妳再試試..."。
那能不能寫好接口文檔,大家都按文檔來開發?很難,因為寫文檔、維護文檔比較麻煩,而且費時,還會經常出現 API 更新了,但文檔還是舊的,各種同步不壹致的情況,從而耽擱彼此的時間。
之前我們團隊也遇到了同樣的問題,那麽作為研發團隊的負責人,我是如何帶領團隊解決這個問題的呢?
方法其實很簡單,如果能做到讓寫文檔/維護文檔這件事情的短期收益就能遠高於付出的成本,那麽所有問題都能迎刃而解,開發人員就會非常樂意去寫接口文檔。
要做到寫文檔和及時維護文檔的短期收益就能遠高於付出的成本,無非兩個方向:
鑒於此,我們設想如果有壹款工具做到以下這些是不是就非常爽了?
總結下來,我們需要的就是這麽壹款工具:
為此,我們幾乎嘗遍了市面上所有相關的工具,但是很遺憾,沒有找到合適的。
於是,我們自己實現了壹個Postman + Swagger + RAP + JMeter
這個工具就是 Apifox,經常很長壹段時間不斷更新叠代後,我們基本上完全實現了最初的設想,幾乎完美解決了最開始遇到的所有問題,在公司內部大受歡迎。並且也形成了我們自己的最佳實踐。
沒錯,現在我們已經將Apifox產品化對外服務了,妳們團隊也可以直接使用Apifox了。
官網:www.apifox.cn
Apifox = Postman + Swagger + Mock + JMeter
Apifox 是 API 文檔、API 調試、API Mock、API 自動化測試壹體化協作平臺。
通過壹套系統、壹份數據,解決多個系統之間的數據同步問題。只要定義好接口文檔,接口調試、數據 Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發調試使用同壹個工具,接口調試完成後即可保證和接口文檔定義完全壹致。高效、及時、準確!
節省研發團隊的每壹分鐘!
如果妳認為 Apifox 只做了數據打通,來提升研發團隊的效率,那就錯了。Apifox 還做了非常多的創新,來提升開發人員的效率。
通常壹個接口會有多種情況用例,比如 正確用例 參數錯誤用例 數據為空用例 不同數據狀態用例。定義接口的時候定義好這些不同狀態的用例,接口調試的時候直接運行,非常高效。
可以獨立定義數據模型,接口定義時可以直接引用數據模型,數據模型之間也可以相互引用。同樣的數據結構,只需要定義壹次即可多處使用;修改的時候只需要修改壹處,多處實時更新,避免不壹致。
使用 Apifox 調試接口的時候,系統會根據接口文檔裏的定義,自動校驗返回的數據結構是否正確,無需通過肉眼識別,也無需手動寫斷言腳本檢測,非常高效!
Apifox 自動校驗數據結構
設置斷言:
Apifox 設置斷言
運行後,查看斷言結果:
先放壹張圖對比下 Apifox 和其他同類工具 零配置 mock 出來的數據效果:
Apifox Mock 數據結果對比同類工具
可以看出 Apifox 零配置 Mock 出來的數據和真實情況是非常接近的,前端開發可以直接使用,而無需再手動寫 mock 規則。
「Apifox 如何做到高效率、零配置生成非常人性化的 mock 數據」
Apifox 項目可“在線分享” API 文檔,分享出去的 API 文檔可設置為公開或需要密碼訪問,非常方便與外部團隊協作。
體驗地址:/s/ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
根據接口模型定義,自動生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業務代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。
更重要的是:妳可以通過自定義代碼模板來生成符合自己團隊的架構規範的代碼,滿足各種個性化的需求。
接口調試
Apifox 多種主題色可選