close

目錄

一、API調試常用解決方案

1、Postman + Swagger + Mock + JMeter

2、存在的問題

3、Apifox

二、下載與安裝

1、支持多種操作系統,貼心

2、一鍵安裝,簡單

3、自定義環境,節省固定的ip前綴,方便

三、功能特性

1、API 文檔設計

2、API 調試

3、API 自動化測試

4、API 數據 Mock

5、CI 持續集成

6、數據庫操作

7、自動生成代碼

8、支持 HTTP、TCP、RPC

9、數據導入/導出

10、團隊協作

四、最佳實踐

五、後續功能規劃

六、Apifox 下載地址

一、API調試常用解決方案1、Postman + Swagger + Mock + JMeter

作為一個後端開發,我做的大部分項目一般都是基於 Swagger 來管理 API 文檔,基於 Postman 來做接口調試,基於 JMeter 來做接口性能測試,基於 RAP 等工具 Mock API 數據。

2、存在的問題

(1)多系統數據不互通

API設計者、前端開發、後端開發、測試人員大量重複工作。

(2)效率低

可視化程度低、操作不友好。

(3)無法團隊協作

單機離線使用為主,成員之間無法實時同步數據,無法協作。

(4)學習成本高

初學者難以入手,需要大量的學習成本、培訓成本。

(5)數據一致性困難

每次變更,都需要不同角色手動去多套系統修改,維護一致性非常困難。時間久了,不一致性越來越嚴重,最終不可維護。

貌似有一些繁瑣,但也習以為常了,突然有一天,我在逛CSDN的時候,發現了Apifox,好奇的進入了官網看了看,瞬間感覺自己發現了寶藏,下載、安裝、運行、調試,一頓操作猛如虎,酸爽!當天下午,我就組織了部門會議,給大家做了一個簡單的Apifox分享!

3、Apifox

有了 Apifox,我們只需要定義接口文檔就可以直接使用接口調試&測試、數據 Mock 等功能。並且,接口調試完成後即可保證和接口文檔定義完全一致。高效、及時、準確!

根據官網描述,Apifox 主要為我們提供了下面這 4 類功能:

接口設計 :可視化文檔管理,高效便捷,零學習成本! 遵循業界的 OpenApi 3.0 (原 Swagger)、JSON Schema 規範。
接口調試 :這個基本就是 Postman 有的功能,Apifox 上都有。
接口自動化測試 :這個基本就是 JMeter 有的功能,Apifox 上都有,並且要更好用。不過,這個功能目前仍然在持續開發中。
接口數據 Mock :內置 Mock.js 規則引擎,非常方便 mock 出各種數據。

除了上面介紹的功能之外,Apifox 還提供了 CI 持續集成、數據庫操作、自動生成代碼、數據導入/導出、團隊協作等等開箱即用的功能。

二、下載與安裝

下載與安裝:https://apifox.cn/a1javazhiyin

1、支持多種操作系統,貼心2、一鍵安裝,簡單3、自定義環境,節省固定的ip前綴,方便三、功能特性1、API 文檔設計
可視化 API 文檔管理,零學習成本。
支持數據模型,接口之間可以復用相同數據結構。
接口文檔完全遵循 OpenAPI(Swagger) 規範。
支持在線分享 API 文檔,方便與外部團隊協作。
2、API 調試
Postman 有的功能 Apifox 都有(如環境變量、前置/後置腳本、Cookie/Session 全局共享等),並且比 Postman 更高效好用。
自動校驗數據結構:校驗返回的數據結構是否符合文檔定義,自動發現接口數據異常。
可視化的斷言、提取變量、數據庫(SQL)操作等功能。
支持接口用例功能(一個接口多個用例)。

(1)自定義json格式

(2)自動生成json格式數據

(3)返回結果校驗

3、API 自動化測試
完善的 API 場景測試(流程測試)功能,保證接口數據的正確性。
可視化的斷言、提取變量、數據庫(SQL)操作等功能。
支持自定義前置/後置腳本,自動校驗數據正確性。腳本語法 100% 兼容 Postman,降低學習成本。
支持調用 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等語言代碼。
4、API 數據 Mock

Apifox 零配置 Mock 出來的數據和真實情況是非常接近的,前端開發可以直接使用,而無需再手動寫 mock 規則。

Apifox 如何做到高效率、零配置生成非常人性化的 mock 數據

Apifox 根據接口定義里的數據結構、數據類型,自動生成 mock 規則。
Apifox 內置智能 mock 規則庫,根據字段名、字段數據類型,智能優化自動生成的 mock 規則。如:名稱包含字符串image的string類型字段,自動 mock 出一個圖片地址 URL;包含字符串time的string類型字段,自動 mock 出一個時間字符串;包含字符串city的string類型字段,自動 mock 出一個城市名。
Apifox 根據內置規則,可自動識別出圖片、頭像、用戶名、手機號、網址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段,從而 Mock 出非常人性化的數據。
除了內置 mock 規則,用戶還可以自定義規則庫,滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規則。
5、CI 持續集成
支持命令行方式運行 API 測試 (Apifox CLI)。
支持集成 Jenkins 等持續集成工具。
6、數據庫操作
支持讀取數據庫數據,作為 API 請求參數使用。
支持讀取數據庫數據,用來校驗(斷言) API 請求是否成功。
7、自動生成代碼
根據接口/模型定義,自動生成各種語言/框架的業務代碼和 API 請求代碼。
支持 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 種語言及框架。
支持自定義代碼模板,自動生成符合自己團隊的架構規範的代碼,滿足各種個性化的需求。
8、支持 HTTP、TCP、RPC
支持 HTTP(s) 接口管理。
支持 Socket (TCP) 接口管理。
後續將會支持 GraphQL、Dubbo、gRPC、WebSocket 等協議接口。
9、數據導入/導出
支持導出 OpenApi (Swagger)、Markdown、Html 等數據格式,因為可以導出OpenApi格式數據,所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種接口相關的事情。
支持導入 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等數據格式,方便舊項目遷移。
支持定時自動導入OpenApi (Swagger)、apiDoc、Apifox格式數據。

(1)直接將postman接口同步導入Apifox

(2)像swagger一樣生成API文檔

(3)生成時下最流行的markdown文件,牛逼

10、團隊協作
接口數據云端同步,實時更新。
成熟的團隊/項目權限管理,支持管理員、普通成員、只讀成員等角色設置,滿足各類企業的需求。
四、最佳實踐
前端(或後端):在 Apifox 上定好接口文檔初稿。
前後端:一起評審、完善接口文檔,定好接口用例。
前端:使用系統根據接口文檔自動生成的 Mock 數據進入開發,無需手寫 mock 規則。
後端:使用接口用例 調試開發中接口,只要所有接口用例調試通過,接口就開發完成了。如開發過中接口有變化,調試的時候就自動更新了文檔,零成本的保障了接口維護的及時性。
後端:每次調試完一個功能就保存為一個接口用例。
測試人員:直接使用接口用例測試接口。
所有接口開發完成後,測試人員(也可以是後端)使用集合測試功能進行多接口集成測試,完整測試整個接口調用流程。
前後端 都開發完,前端從Mock 數據切換到正式數據,聯調通常都會非常順利,因為前後端雙方都完全遵守了接口定義的規範。
五、後續功能規劃
接口性能測試支持(類似 JMeter);
支持插件市場,可以自己開發插件;
開放 Apifox API,允許開發者通過 API 調用 Apifox 的功能;
支持更多接口協議,如GraphQL、gRPC、websocket等;
支持離線使用,項目可選擇在線同步(團隊協作)還是僅本地存儲(單機離線使用);
六、Apifox 下載地址

介紹了Apifox這麼多實用的功能,用上了才是真福利! 軟件完全免費,堪稱國產良心,有興趣有需求的小夥伴,可以去官網:

https://apifox.cn/a1javazhiyin

了解詳情。

要是使用過程中有問題的話,還可以加入 Apifox 用戶群提問和學習。

arrow
arrow
    全站熱搜
    創作者介紹
    創作者 鑽石舞台 的頭像
    鑽石舞台

    鑽石舞台

    鑽石舞台 發表在 痞客邦 留言(0) 人氣()