Apifox,比swagger更好用!
靜態(tài)的 Swagger 們跟不上頻繁變更的代碼
“為什么改了這個(gè)沒(méi)告訴我”,“實(shí)際功能和文檔上說(shuō)的不一樣啊”。這些話大家做開(kāi)發(fā)的想必耳朵都聽(tīng)出老繭了。真不是故意的,有時(shí)候任務(wù)比較急,就先改了代碼,想著以后再同步文檔,然后就給忘了。項(xiàng)目更新又全靠社交軟件通知,人一多難免有一兩個(gè)沒(méi)及時(shí)溝通到的。確實(shí)給合作的小伙伴帶來(lái)麻煩,但說(shuō)實(shí)話開(kāi)發(fā)也挺委屈的。
這些問(wèn)題產(chǎn)生的主要原因是,當(dāng)前大部分研發(fā)團(tuán)隊(duì)的工作流程是這樣的:

這種模式帶來(lái)的問(wèn)題是:
1. Swagger ,postman ,MockJS 只能完成軟件研發(fā)流程中某個(gè)環(huán)節(jié)的功能,造成完成接口設(shè)計(jì),文檔編寫,調(diào)試,測(cè)試驗(yàn)證等工作需要使用好幾個(gè)工具;
2.更麻煩的是這些工具數(shù)據(jù)格式不互通,無(wú)法互相導(dǎo)入,造成用 Swagger 定義和編寫完成接口后,在 Postman, MockJS , Jmeter 等工具還要再去手動(dòng)填寫一遍才能開(kāi)始工作,增加了無(wú)意義的工作量。
3.溝通成本總是被忽略不計(jì),但實(shí)際上不僅占據(jù)了很大時(shí)間,各種溝通不及時(shí)、溝通不到位還非常讓人心累。
4.老板的需求來(lái)得急,老板的需求變得快,各種代碼修改和變更難以及時(shí)通知和同步到團(tuán)隊(duì)成員手中。
抱怨當(dāng)然政治正確,但有啥用,該加的班還是要加。那么有什么辦法可以解決這個(gè)問(wèn)題嗎?
有的。
換個(gè)工具。
低成本做長(zhǎng)期主義的事情
我為大家提供的解決方案是一款國(guó)內(nèi)的生產(chǎn)力工具——?Apifox?。
作為一款研發(fā)全流程,接口全周期的生產(chǎn)力工具,這款軟件真正完成了數(shù)據(jù)流的打通,在一個(gè)軟件上就能實(shí)現(xiàn)接口設(shè)計(jì)—接口文檔—接口調(diào)試—接口修改—接口 mock —接口測(cè)試—接口自動(dòng)化—接口迭代的工作流閉環(huán);
后端,前端,測(cè)試各個(gè)角色既能各取所需,又能協(xié)同合作。

Apifox 上的協(xié)作流程是這樣的:
后端在 Apifox?
可視化接口設(shè)計(jì)界面
上定義好項(xiàng)目各個(gè)接口及對(duì)應(yīng)參數(shù)
同時(shí)編寫接口文檔說(shuō)明
前后端一起評(píng)審,修改完善
接口
并在同一界面
順手更新接口文檔
后端使用
接口調(diào)試
功能調(diào)試接口前端使用
零配置高仿真 mock
?功能對(duì)前端頁(yè)面進(jìn)行調(diào)試,無(wú)需手寫 mock 規(guī)則后端使用
代碼生成
功能直接生成接口代碼
測(cè)試在接口管理頁(yè)面一鍵生成
接口參數(shù)測(cè)試用例
,并依據(jù)業(yè)務(wù)場(chǎng)景
生成自動(dòng)化測(cè)試用例,一鍵運(yùn)行
接口用例并生成接口測(cè)試報(bào)告
并分享給相關(guān)人員。前后端?都開(kāi)發(fā)完,前端從
?Mock 數(shù)據(jù)
切換到正式數(shù)據(jù)
,進(jìn)行聯(lián)調(diào),由于使用同一個(gè)接口數(shù)據(jù)源,且遵循了接口規(guī)范,聯(lián)調(diào)順利由于
bug 修復(fù)
或需求變更
,接口發(fā)生了變化,后端修改提交
后,前端和測(cè)試實(shí)時(shí)同步
到了修改后的數(shù)據(jù)項(xiàng)目經(jīng)理通過(guò)權(quán)限設(shè)置給
研發(fā)
,產(chǎn)品
,測(cè)試
,外部合作人員
分配編輯
,只讀
等各種操作權(quán)限,維護(hù)了項(xiàng)目安全項(xiàng)目經(jīng)理通過(guò)各個(gè)接口的狀態(tài)
開(kāi)發(fā)中
,測(cè)試中
,已發(fā)布
來(lái)跟進(jìn)項(xiàng)目的進(jìn)度情況,把控項(xiàng)目風(fēng)險(xiǎn)。
Apifox 核心功能和界面是這樣的:




36氪報(bào)道過(guò),?Apifox 在 Pre-A 輪融資就得到了 3000 萬(wàn)元的融資。?資本市場(chǎng)如此看好這個(gè)產(chǎn)品的發(fā)展?jié)摿Γ且驗(yàn)樵诮?jīng)濟(jì)增速變緩的現(xiàn)階段,
對(duì)企業(yè)來(lái)說(shuō),它能通過(guò)提高整體的合作效率來(lái)為企業(yè)節(jié)約成本;
對(duì)研發(fā)人員來(lái)說(shuō),可以減少無(wú)意義的工作量和繁雜耗時(shí)的溝通成本,將時(shí)間花在能提升自身競(jìng)爭(zhēng)力的地方。
?Apifox > Swagger + Postman + mockJS + Jmeter ,它在傳統(tǒng)軟件的基礎(chǔ)上做了不少操作優(yōu)化和團(tuán)隊(duì)協(xié)同提效的功能。
Apifox 做的增速提效優(yōu)化
1.接口設(shè)計(jì):從代碼生成界面到可視化接口設(shè)計(jì)界面
Apifox 接口文檔遵循 OpenApi 3.0 (原 Swagger )、 JSON Schema 規(guī)范,可生成在線文檔;零學(xué)習(xí)成本即可編寫出符合 RESTful 風(fēng)格的接口文檔,新人上手快;所見(jiàn)即所得,不易出錯(cuò)。


2.文檔維護(hù):從接口與文檔分離到接口與文檔合并
當(dāng)你接手舊項(xiàng)目時(shí),發(fā)現(xiàn)接口是上周的,接口文檔是商周的,上手新項(xiàng)目全靠老司機(jī)口口相傳,內(nèi)心大概是崩潰的吧。
接口與文檔分離常常導(dǎo)致維護(hù)困難。Apifox 的接口設(shè)計(jì)界面提供了 Markdown 格式的文檔說(shuō)明區(qū),修改完接口就如同 commit 代碼時(shí)添加變更說(shuō)明般,自然而然地形成肌肉記憶。

3.數(shù)據(jù)復(fù)用:從各自為政到定義一次、多次復(fù)用
接口數(shù)據(jù)復(fù)用:Swagger ,Postman ,MockJS ,Jmeter 等軟件彼此之間數(shù)據(jù)不互通,數(shù)據(jù)格式不一致,接口導(dǎo)入非常耗時(shí)麻煩。
而 Apifox 能身兼多職,包攬上述軟件功能,在 Apifox 中定義一次接口,能被后端直接用來(lái)調(diào)試,前端直接用來(lái) mock 界面,測(cè)試直接執(zhí)行接口自動(dòng)化。
數(shù)據(jù)模型復(fù)用:可復(fù)用的數(shù)據(jù)結(jié)構(gòu),定義接口返回?cái)?shù)據(jù)結(jié)構(gòu)
及請(qǐng)求參數(shù)數(shù)據(jù)結(jié)構(gòu)
(僅 JSON 和 XML 模式)時(shí)可直接引用。


4.同步更新,高效溝通:從溝通滯后到數(shù)據(jù)變更即時(shí)同步
當(dāng)前團(tuán)隊(duì)成員之間同步項(xiàng)目信息數(shù)據(jù),仍舊依靠著社交軟件,低效、不及時(shí),也容易漏掉某些成員。
Apifox 為此提供了同步功能,一旦接口數(shù)據(jù)有更新發(fā)生,就會(huì)即時(shí)同步更新并通知到項(xiàng)目?jī)?nèi)所有成員。

5.零配置 mock 高仿真數(shù)據(jù):從苦逼造數(shù)據(jù)到零配置 mock 真實(shí)數(shù)據(jù)
Apifox 根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型,自動(dòng)生成
?mock 規(guī)則。Apifox?內(nèi)置智能 mock 規(guī)則庫(kù)
,根據(jù)字段名、字段數(shù)據(jù)類型,智能優(yōu)化自動(dòng)生成的 mock 規(guī)則。
用戶還可以自定義規(guī)則庫(kù)
,滿足各種個(gè)性化需求。支持使用 正則表達(dá)式、通配符 來(lái)匹配字段名自定義 mock 規(guī)則。

除此之外
6.舊有項(xiàng)目無(wú)痛遷移
目前 Apifox 支持 OpenApi,Postman,Jmeter 等數(shù)據(jù)格式導(dǎo)入,方便舊有項(xiàng)目一鍵無(wú)痛遷移到 Apifox ,無(wú)需再次新建項(xiàng)目。

項(xiàng)目也支持以 html 或者 OpenApi ,Markdown 格式導(dǎo)出,可用于數(shù)據(jù)備份
或合作人員查看
。

7.API Hub
內(nèi)置企業(yè)微信開(kāi)放 API ,抖音開(kāi)放 API 等第三方接口開(kāi)放項(xiàng)目,接口可以直接在? Apifox 中調(diào)試,不需要到處找接口文檔和手工填寫接口。

同時(shí) Apifox 也提供了網(wǎng)頁(yè)版 API Hub ,直接在網(wǎng)頁(yè)端調(diào)試也完全沒(méi)問(wèn)題。

8.Web 版本
除了客戶端,還支持 web 版本,用戶可以移動(dòng)辦公,任意切換設(shè)備,適合緊急加班這種情況。

9.完全免費(fèi)
這個(gè)軟件 SaaS 版本官方已經(jīng)承諾永久免費(fèi),只有私有化部署是付費(fèi)的。而且 SaaS 版本不限接口數(shù)量,不限項(xiàng)目人數(shù),不限功能,非常厚道,對(duì)于日常開(kāi)發(fā)來(lái)說(shuō), SaaS 版本已經(jīng)完全夠用了。
