推薦一款技術人必備的接口測試神器:Apifox

1. 背景

做爲互聯網行業技術從業者,接口調試是必不可少的一項技能,一般咱們都會選擇使用 Postman 這類工具來進行接口調試,在接口調試方面 Postman 作的確實很是出色。固然除了Postman,還有它的老婆: Postwoman也一樣很出色,公號以前有發表過一篇關於它老婆Postwoman使用的文章,詳細可閱:推薦一款 Postman 的開源替代品: Postwomanhtml

可是在整個軟件開發過程當中,接口調試只是其中的一部分,還有不少事情 Postman 是沒法完成的,或者沒法高效完成,好比:接口文檔定義、Mock 數據、接口自動化測試等等。前端

今天給你們推薦的一款神器: Apifox,它是集:接口文檔管理接口調試Mock接口自動化測試於一體的。有的讀者咋一看,會以爲和YAPI有點相似,但二者在功能特點上,只能說是各有千秋的。json

細心的讀者,會發現文章,正文乾貨尚未開始,就已經爲你們推薦了三款效率神器: Apifox、Postwoman、YAPI。後端

2. 聊一聊接口管理的現狀

對於接口管理的現狀來講,目前行業大部分採起的解決方案有以下幾種:api

  • 使用 Swagger 管理接口文檔。數據結構

  • 使用 Postman 調試接口。架構

  • 使用 RAP或Easy Mock來進行 Mock 數據。框架

  • 使用 JMeter 作接口自動化測試。工具

上述的接口管理手段,咋一看,貌似沒有什麼問題,但仔細分析,不難發現,當中存在的問題還真很多,好比要維護不一樣工具,而且這些工具之間數據一致性很是困難、很是低效。這裏不只僅是工做量的問題,更大的問題是多個系統之間數據不一致,致使協做低效,頻繁出問題,開發人員、測試人員痛苦不堪。性能

設想一下這樣的一個協做流程:

  1. 開發人員在 Swagger 定義好文檔後,接口調試的時候還須要去 Postman 再定義一遍。
  2. 前端開發 Mock 數據的時候又要去 RAP 或Easy Mock定義一遍,手動設置好 Mock 規則。
  3. 測試人員須要去 JMeter 定義一遍。
  4. 前端根據 RAP 或Easy Mock定義 Mock 出來的數據開發完,後端根據 Swagger 定義的接口文檔開發完,各自測試測試經過了,本覺得能夠立刻上線,結果一對接發現各類問題:原來開發過程當中接口變動,只修改了 Swagger,可是沒有及時同步修改 RAP 或Easy Mock。
  5. 一樣,測試在 JMeter 寫好的測試用例,真正運行的時候也會發現各類不一致。
  6. 時間久了,各類不一致會愈來愈嚴重。

3. Apifor介紹

官方對Apifor定位,Apifox = Postman + Swagger + Mock + JMeter,以下圖所示

Apifox目標是經過一套系統、一份數據,解決多個系統之間的數據同步問題。只要定義好接口文檔,接口調試、數據 Mock、接口測試就能夠直接使用,無需再次定義;接口文檔和接口開發調試使用同一個工具,接口調試完成後便可保證和接口文檔定義徹底一致。高效、及時、準確!

官方地址:https://www.apifox.cn/#

歸納來說,Apifox經常使用 功能分爲四類功能:

  1. 接口文檔定義功能:Apifox 遵循 OpenApi 3.0 (原Swagger)、JSON Schema 規範的同時,提供了很是好用的可視化文檔管理功能,零學習成本,很是高效。
  2. 接口調試功能:Postman 有的功能,好比環境變量、預執行腳本、後執行腳本、Cookie/Session 全局共享 等功能,Apifox 都有,而且和 Postman 同樣高效好用。
  3. 數據 Mock功能:內置 Mock.js 規則引擎,很是方便 mock 出各類數據,而且能夠在定義數據結構的同時寫好 mock 規則。支持添加「指望」,根據請求參數返回不一樣 mock 數據。最重要的是 Apifox 零配置 便可 Mock 出很是人性化的數據,具體在本文後面介紹。
  4. 接口自動化測試:提供接口集合測試,能夠經過選擇接口(或接口用例)快速建立測試集。目前接口自動化測試更多功能還在開發中!目標是: JMeter 有的功能基本都會有,而且要更好用。

4. Apifor小試牛刀

接下來,帶着你們,來體驗一下Apifor的使用。

一、先在官網下載對應系統安裝包,進行安裝,安裝完成後,第一次啓動須要先登陸。

Ps: 登陸前,須要先經過郵箱來註冊一個賬號。

2、 登陸成功後,Apifox默認給了一些例子,若是看它的界面會發現和Postman界面比較類似。

Ps: 固然也不要被它的外表所欺騙了,仍是有別於Postman的。

3、在本地啓一個API服務,端口爲8000, 在Apifor上,新建一個新的測試環境,以下所示:

4、新建一分類:接口測試,或直接在默認分類上,新建一條接口用例,以下所示

如上圖,添加對應的基礎信息、配置請求參數等。

5、選擇測試環境,點擊發送按鈕,運行接口測試用例。

看到這裏,可能有些讀者以爲和Postman功能基本是同樣的,不妨接着往下看。

5. Apifor更多特性

一、調試時自動校驗數據結構

使用 Apifox 調試接口的時候,系統會根據接口文檔裏的定義,自動校驗返回的數據結構是否正確,無需經過肉識別,也無需手動寫斷言腳本檢測,很是高效!

img

根據官方的示例能夠看出,在運行集合測試時,能夠結合自動校驗數據結構的功能, 清晰展現出失敗用例校驗不經過的緣由。

img

2、零配置 Mock 出很是人性化的數據

1、 爲上述示例,添加一個mock測試服務,配置以下所示:

按照接口字段數據格式要求,根據mock.js語法,配置保存完畢,運行後,自動生成一個mock服務。

其中,Mock.js語法示例可見:http://mockjs.com/examples.html

能夠看出 Apifox 零配置 Mock 出來的數據和真實狀況是很是接近的,前端開發能夠直接使用,而無需再手動寫mock規則。

3、代碼自動生成

根據接口模型定義,自動生成各類語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業務代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。

img

更重要的是:你能夠經過自定義代碼模板來生成符合本身團隊的架構規範的代碼,知足各類個性化的需求。

4、導入、導出

  1. 支持導出 OpenApi (原Swagger)MarkdownHtml 等數據格式,由於能夠導出OpenApi格式數據,因此你能夠利用 OpenApi (Swagger) 豐富的生態工具完成各類接口相關的事情。
  2. 支持導入 OpenApi (原Swagger)PostmanHARRAP2yapiEolinkerDOCleverApiPostApizza 等數據格,方便遷移舊項目。

img

6. 小結

雖然Apifox目前有些功能還並不完善,但整的來講,Apifox仍是不錯的,也爲接口開發調試測試提供了一種效率更佳的的解決方案,按照Apifox開發團隊後續規劃,後續會重加增長接口性能測試能力支持(相似JMeter)、支持離線團隊多人協做等特性。

相關文章
相關標籤/搜索