首頁 > 易卦

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

作者:由 文淵閣書童 發表于 易卦日期:2022-08-18

lua怎麼取變數地址

作為一個

Web前端開發者

,開發過程中除了寫業務程式碼,剩餘大多數時間都花在了

API

的聯調上。為了解決這個問題,大多數開發者會選擇

Mock

介面的方案,但是前端領域的幾種常用 Mock 方案都需要一定的學習成本。那麼有沒更優雅便捷的方案可以提高開發者開發效率實現下班自由呢。

一款對前端開發者最佳化的 API 管理工具

假設我們現在要開發一個獲取使用者資訊的功能,常規流程是這樣的:

介面設計。

後端開發介面(此時前端開發頁面)。

後端介面開發測試完成,交付前端進行開發除錯測試。

現在我們使用 Apifox 來參與開發會怎麼樣呢?

1。 介面設計

在介面設計的環節,我們使用 Apifox 進行,透過 Apifox 可以完全視覺化的形式進行一個介面的設計,開啟 Apifox,新建一個介面:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

介面文件設計完成後,點選儲存,Apifox 會儲存此介面生成一個介面文件:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

2。 介面測試

在介面設計完成後,Apifox 會儲存介面文件,文件內有介面的請求與返回資訊,此時可以使用 Apifox 內建的 Mock 服務進行除錯:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

可以看到介面返回資料中自動 Mock 返回了資料,並且 Apifox 會根據常用欄位命名,智慧的得出人性化的 Mock 資料,並且會根據介面設計時每個欄位的資料型別,去校驗介面返回資料對應欄位的資料型別。

{ “data”: { “username”: “廖磊”, // 中文姓名 “avatar”: “http://dummyimage。com/100x100” // 頭像URL }, “code”: 100, // 介面狀態碼 “message”: “occaecat aute proident non” // 介面返回額外資訊}

3。 前端除錯

在 Apifox 執行時,我們可以在外部直接訪問起內建的 Mock 服務,這意味者,前端開發者不需要單獨寫 Mock 程式碼,在介面文件設計完成的時候,便可以直接除錯!

我們把剛剛除錯的 URL 直接複製帶瀏覽器中,可以直接返回資料!那麼我們便可以直接在專案中使用。

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

Apifox 還提供了

高階Mock

的功能(

具體文件可看

), 我們預期在傳入

id=1

的時候,介面能返回我們想要的資料,例如:

{ “data”: { “username”: “zh”, “avatar”: “http://dummyimage。com/100x100” }, “code”: 200, “message”: “success”}

使用 Apifox 的

高階Mock

功能新增一個:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

再次發起請求,此時在引數

id

賦值為

1

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

可以看到得到了我們預期的返回!

那麼我們在前端開發時,便可以直接使用 Apifox 的 Mock 服務進行介面聯調,等到後端同學完成了介面開發後,便可以無縫切換為真實的介面,因為 Apifox 是以介面設計優先,前後端都嚴格依照介面文件定義來開發。這樣對前端如此友好的工具,用了就回不去!

Apifox 是什麼

Apifox

是 API 文件、API 除錯、API Mock、API 自動化測試一體化協作平臺,定位

Postman + Swagger + Mock + JMeter

。透過一套系統、一份資料,解決多個系統之間的資料同步問題。只要定義好 API 文件,API 除錯、API 資料 Mock、API 自動化測試就可以直接使用,無需再次定義;API 文件和 API 開發除錯使用同一個工具,API 除錯完成後即可保證和 API 文件定義完全一致。高效、及時、準確!

1、Apifox 定位

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文件、API 除錯、API Mock、API 自動化測試一體化協作平臺。

透過一套系統、一份資料,解決多個系統之間的資料同步問題。只要定義好介面文件,介面除錯、資料 Mock、介面測試就可以直接使用,無需再次定義;介面文件和介面開發除錯使用同一個工具,介面除錯完成後即可保證和介面文件定義完全一致。高效、及時、準確!

2、Apifox 宗旨

節省研發團隊的每一分鐘!

3、Apifox 功能

介面設計

:Apifox 介面文件遵循

OpenApi

3。0 (原 Swagger)、

JSON Schema

規範的同時,提供了非常好用的

視覺化

文件管理功能,零學習成本,非常高效。並且支援線上分享介面文件。

資料模型

:可複用的資料結構,定義介面

返回資料結構

請求引數資料結構

(僅 JSON 和 XML 模式)時可直接引用。支援模型直接巢狀引用,直接 JSON/XML 智慧匯入,支援 oneOf、allOf 等高階組合模式。

介面除錯

:Postman 有的功能,比如環境變數、前置/後置指令碼、Cookie/Session 全域性共享 等功能,Apifox 都有,並且比 Postman 更高效好用。介面執行完之後點選

儲存為用例

按鈕,即可生成

介面用例

,後續可直接執行介面用例,無需再輸入引數,非常方便。自定義指令碼 100% 相容 Postman 語法,並且支援執行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各種語言程式碼。

介面用例

:通常一個介面會有多種情況用例,比如

引數正確

用例、

引數錯誤

用例、

資料為空

用例、

不同資料狀態

用例等等。執行介面用例時會自動校驗資料正確性,用介面用例來除錯介面非常高效。

介面資料 Mock

:內建

Mock。js

規則引擎,非常方便 mock 出各種資料,並且可以在定義資料結構的同時寫好 mock 規則。支援新增“期望”,根據請求引數返回不同 mock 資料。最重要的是 Apifox

零配置

即可 Mock 出非常人性化的資料,具體在本文後面介紹。

資料庫操作

:支援讀取資料庫資料,作為介面請求引數使用。支援讀取資料庫資料,用來校驗(斷言)介面請求是否成功。

介面自動化測試

:提供介面集合測試,可以透過選擇介面(或介面用例)快速建立測試集。目前介面自動化測試更多功能還在開發中,敬請期待!目標是: JMeter 有的功能基本都會有,並且要更好用。

快捷除錯

:類似 Postman 的介面除錯方式,主要用途為臨時除錯一些

無需文件化

的介面,無需提前定義介面即可快速除錯。

程式碼生成

:根據介面及資料資料模型定義,系統自動生成

介面請求程式碼

前端業務程式碼

後端業務程式碼

團隊協作

:Apifox 天生就是為團隊協作而生的,介面雲端實時同步更新,成熟的

團隊/專案/成員許可權

管理,滿足各類企業的需求。

Apifox 做的不僅僅是資料打通

如果你認為 Apifox 只做了資料打通,來提升研發團隊的效率,那就錯了。Apifox 還做了非常多的創新,來提升開發人員的效率。

1、介面支援“用例管理”

通常一個介面會有多種情況用例,比如

正確用例

引數錯誤用例

資料為空用例

不同資料狀態用例

。定義介面的時候定義好這些不同狀態的用例,介面除錯的時候直接執行,非常高效。

2、“資料模型”定義、引用

可以獨立定義資料模型,介面定義時可以直接引用資料模型,資料模型之間也可以相互引用。同樣的資料結構,只需要定義一次即可多處使用;修改的時候只需要修改一處,多處實時更新,避免不一致。

3、除錯時“自動校驗”資料結構

使用 Apifox 除錯介面的時候,系統會根據介面文件裡的定義,自動校驗返回的資料結構是否正確,無需透過肉眼識別,也無需手動寫斷言指令碼檢測,非常高效!

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

Apifox 自動校驗資料結構

4、“視覺化”設定斷言

設定斷言:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

Apifox 設定斷言

執行後,檢視斷言結果:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

5、“視覺化”設定提取變數

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

6、支援資料庫操作

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

7、“零配置”Mock 出非常人性化的資料

先放一張圖對比下 Apifox 和其他同類工具

零配置

mock 出來的資料效果:

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

Apifox 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 規則。

8、生成線上介面文件

Apifox 專案可“線上分享” API 文件,分享出去的 API 文件可設定為公開或需要密碼訪問,非常方便與外部團隊協作。

體驗地址:

介面文件線上分享 - Apipark

推薦一款API管理工具,集Swagger+mock+Postman+Jmeter於一身

9、程式碼自動生成

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

更重要的是:你可以透過

自定義程式碼模板

來生成符合自己團隊的架構規範的程式碼,滿足各種個性化的需求。

10、匯入、匯出

支援匯出

OpenApi (Swagger)

Markdown

Html

等資料格式,因為可以匯出

OpenApi

格式資料,所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種介面相關的事情。

支援匯入

OpenApi (Swagger)

Postman

HAR

RAML

RAP2

YApi

Eolinker

NEI

DOClever

ApiPost

Apizza

ShowDoc

API Blueprint

I/O Docs

WADL

Google Discovery

等資料格式,方便舊專案遷