作為一個
Web前端開發(fā)者
,開發(fā)過程中除了寫業(yè)務(wù)代碼,剩余大多數(shù)時間都花在了API
的聯(lián)調(diào)上。為了解決這個問題,大多數(shù)開發(fā)者會選擇Mock
接口的方案,但是前端領(lǐng)域的幾種常用 Mock 方案都需要一定的學(xué)習(xí)成本。那么有沒更優(yōu)雅便捷的方案可以提高開發(fā)者開發(fā)效率實現(xiàn)下班自由呢。
假設(shè)我們現(xiàn)在要開發(fā)一個獲取用戶信息的功能,常規(guī)流程是這樣的:
現(xiàn)在我們使用 Apifox 來參與開發(fā)會怎么樣呢?
在接口設(shè)計的環(huán)節(jié),我們使用 Apifox 進行,通過 Apifox 可以完全可視化的形式進行一個接口的設(shè)計,打開 Apifox,新建一個接口:
接口文檔設(shè)計完成后,點擊保存,Apifox 會保存此接口生成一個接口文檔:
在接口設(shè)計完成后,Apifox 會保存接口文檔,文檔內(nèi)有接口的請求與返回信息,此時可以使用 Apifox 內(nèi)置的 Mock 服務(wù)進行調(diào)試:
可以看到接口返回數(shù)據(jù)中自動 Mock 返回了數(shù)據(jù),并且 Apifox 會根據(jù)常用字段命名,智能的得出人性化的 Mock 數(shù)據(jù),并且會根據(jù)接口設(shè)計時每個字段的數(shù)據(jù)類型,去校驗接口返回數(shù)據(jù)對應(yīng)字段的數(shù)據(jù)類型。
{
"data": {
"username": "廖磊", // 中文姓名
"avatar": "http://dummyimage.com/100x100" // 頭像URL
},
"code": 100, // 接口狀態(tài)碼
"message": "occaecat aute proident non" // 接口返回額外信息
}
在 Apifox 運行時,我們可以在外部直接訪問起內(nèi)置的 Mock 服務(wù),這意味者,前端開發(fā)者不需要單獨寫 Mock 代碼,在接口文檔設(shè)計完成的時候,便可以直接調(diào)試!
我們把剛剛調(diào)試的 URL 直接復(fù)制帶瀏覽器中,可以直接返回數(shù)據(jù)!那么我們便可以直接在項目中使用。
Apifox 還提供了高級Mock
的功能(具體文檔可看),
我們預(yù)期在傳入id=1
的時候,接口能返回我們想要的數(shù)據(jù),例如:
{
"data": {
"username": "zh",
"avatar": "http://dummyimage.com/100x100"
},
"code": 200,
"message": "success"
}
使用 Apifox 的高級Mock
功能添加一個:
再次發(fā)起請求,此時在參數(shù)id
賦值為1
:
可以看到得到了我們預(yù)期的返回!
那么我們在前端開發(fā)時,便可以直接使用 Apifox 的 Mock 服務(wù)進行接口聯(lián)調(diào),等到后端同學(xué)完成了接口開發(fā)后,便可以無縫切換為真實的接口,因為 Apifox 是以接口設(shè)計優(yōu)先,前后端都嚴格依照接口文檔定義來開發(fā)。這樣對前端如此友好的工具,用了就回不去!
Apifox 是 API 文檔、API 調(diào)試、API Mock、API 自動化測試一體化協(xié)作平臺,定位
Postman + Swagger + Mock + JMeter
。通過一套系統(tǒng)、一份數(shù)據(jù),解決多個系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好 API 文檔,API 調(diào)試、API 數(shù)據(jù) Mock、API 自動化測試就可以直接使用,無需再次定義;API 文檔和 API 開發(fā)調(diào)試使用同一個工具,API 調(diào)試完成后即可保證和 API 文檔定義完全一致。高效、及時、準(zhǔn)確!
Apifox = Postman + Swagger + Mock + JMeter
Apifox 是 API 文檔、API 調(diào)試、API Mock、API 自動化測試一體化協(xié)作平臺。
通過一套系統(tǒng)、一份數(shù)據(jù),解決多個系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔,接口調(diào)試、數(shù)據(jù) Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發(fā)調(diào)試使用同一個工具,接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時、準(zhǔn)確!
節(jié)省研發(fā)團隊的每一分鐘!
接口設(shè)計:Apifox 接口文檔遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 規(guī)范的同時,提供了非常好用的可視化
文檔管理功能,零學(xué)習(xí)成本,非常高效。并且支持在線分享接口文檔。
數(shù)據(jù)模型:可復(fù)用的數(shù)據(jù)結(jié)構(gòu),定義接口返回數(shù)據(jù)結(jié)構(gòu)
及請求參數(shù)數(shù)據(jù)結(jié)構(gòu)
(僅 JSON 和 XML 模式)時可直接引用。支持模型直接嵌套引用,直接 JSON/XML 智能導(dǎo)入,支持 oneOf、allOf 等高級組合模式。
接口調(diào)試:Postman 有的功能,比如環(huán)境變量、前置/后置腳本、Cookie/Session 全局共享 等功能,Apifox 都有,并且比 Postman 更高效好用。接口運行完之后點擊保存為用例
按鈕,即可生成接口用例
,后續(xù)可直接運行接口用例,無需再輸入?yún)?shù),非常方便。自定義腳本 100% 兼容 Postman 語法,并且支持運行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各種語言代碼。
接口用例:通常一個接口會有多種情況用例,比如參數(shù)正確
用例、參數(shù)錯誤
用例、數(shù)據(jù)為空
用例、不同數(shù)據(jù)狀態(tài)
用例等等。運行接口用例時會自動校驗數(shù)據(jù)正確性,用接口用例來調(diào)試接口非常高效。
接口數(shù)據(jù) Mock:內(nèi)置 Mock.js 規(guī)則引擎,非常方便 mock 出各種數(shù)據(jù),并且可以在定義數(shù)據(jù)結(jié)構(gòu)的同時寫好 mock 規(guī)則。支持添加“期望”,根據(jù)請求參數(shù)返回不同 mock 數(shù)據(jù)。最重要的是 Apifox 零配置
即可 Mock 出非常人性化的數(shù)據(jù),具體在本文后面介紹。
數(shù)據(jù)庫操作:支持讀取數(shù)據(jù)庫數(shù)據(jù),作為接口請求參數(shù)使用。支持讀取數(shù)據(jù)庫數(shù)據(jù),用來校驗(斷言)接口請求是否成功。
接口自動化測試:提供接口集合測試,可以通過選擇接口(或接口用例)快速創(chuàng)建測試集。目前接口自動化測試更多功能還在開發(fā)中,敬請期待!目標(biāo)是: JMeter 有的功能基本都會有,并且要更好用。
快捷調(diào)試:類似 Postman 的接口調(diào)試方式,主要用途為臨時調(diào)試一些無需文檔化
的接口,無需提前定義接口即可快速調(diào)試。
代碼生成:根據(jù)接口及數(shù)據(jù)數(shù)據(jù)模型定義,系統(tǒng)自動生成接口請求代碼
、前端業(yè)務(wù)代碼
及后端業(yè)務(wù)代碼
。
團隊協(xié)作:Apifox 天生就是為團隊協(xié)作而生的,接口云端實時同步更新,成熟的團隊/項目/成員權(quán)限
管理,滿足各類企業(yè)的需求。
如果你認為 Apifox 只做了數(shù)據(jù)打通,來提升研發(fā)團隊的效率,那就錯了。Apifox 還做了非常多的創(chuàng)新,來提升開發(fā)人員的效率。
通常一個接口會有多種情況用例,比如 正確用例
參數(shù)錯誤用例
數(shù)據(jù)為空用例
不同數(shù)據(jù)狀態(tài)用例
。定義接口的時候定義好這些不同狀態(tài)的用例,接口調(diào)試的時候直接運行,非常高效。
可以獨立定義數(shù)據(jù)模型,接口定義時可以直接引用數(shù)據(jù)模型,數(shù)據(jù)模型之間也可以相互引用。同樣的數(shù)據(jù)結(jié)構(gòu),只需要定義一次即可多處使用;修改的時候只需要修改一處,多處實時更新,避免不一致。
使用 Apifox 調(diào)試接口的時候,系統(tǒng)會根據(jù)接口文檔里的定義,自動校驗返回的數(shù)據(jù)結(jié)構(gòu)是否正確,無需通過肉眼識別,也無需手動寫斷言腳本檢測,非常高效!
設(shè)置斷言:
運行后,查看斷言結(jié)果:
先放一張圖對比下 Apifox 和其他同類工具 零配置
mock 出來的數(shù)據(jù)效果:
可以看出 Apifox 零配置
Mock 出來的數(shù)據(jù)和真實情況是非常接近的,前端開發(fā)可以直接使用,而無需再手動寫 mock 規(guī)則。
Apifox 如何做到高效率
、零配置
生成非常人性化的 mock 數(shù)據(jù)
Apifox 根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型,自動生成 mock 規(guī)則。
Apifox 內(nèi)置智能 mock 規(guī)則庫,根據(jù)字段名、字段數(shù)據(jù)類型,智能優(yōu)化自動生成的 mock 規(guī)則。如:名稱包含字符串image
的string
類型字段,自動 mock 出一個圖片地址 URL;包含字符串time
的string
類型字段,自動 mock 出一個時間字符串;包含字符串city
的string
類型字段,自動 mock 出一個城市名。
Apifox 根據(jù)內(nèi)置規(guī)則,可自動識別出圖片、頭像、用戶名、手機號、網(wǎng)址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段,從而 Mock 出非常人性化的數(shù)據(jù)。
除了內(nèi)置 mock 規(guī)則,用戶還可以自定義規(guī)則庫,滿足各種個性化需求。支持使用 正則表達式
、通配符
來匹配字段名自定義 mock 規(guī)則。
Apifox 項目可“在線分享” API 文檔,分享出去的 API 文檔可設(shè)置為公開或需要密碼訪問,非常方便與外部團隊協(xié)作。
體驗地址:https://www.apipark.cn/s/ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
根據(jù)接口模型定義,自動生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業(yè)務(wù)代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。
更重要的是:你可以通過自定義代碼模板
來生成符合自己團隊的架構(gòu)規(guī)范的代碼,滿足各種個性化的需求。
支持導(dǎo)出 OpenApi (Swagger)
、Markdown
、Html
等數(shù)據(jù)格式,因為可以導(dǎo)出OpenApi
格式數(shù)據(jù),所以你可以利用 OpenApi (Swagger) 豐富的生態(tài)工具完成各種接口相關(guān)的事情。
支持導(dǎo)入 OpenApi (Swagger)
、Postman
、HAR
、RAML
、RAP2
、YApi
、Eolinker
、NEI
、DOClever
、ApiPost
、Apizza
、ShowDoc
、API Blueprint
、I/O Docs
、WADL
、Google Discovery
等數(shù)據(jù)格式,方便舊項目遷
聯(lián)系客服