最近一直在思考如何對Web API的其接口數(shù)據(jù)進行獨立開發(fā)的問題,隨著Web API的越來越廣泛應(yīng)用,很多開發(fā)也要求前端后端分離,例如統(tǒng)一的Web API接口后,Winform團隊、Web前端團隊、微信小程序或者APP團隊大家可以同步開發(fā),在最初約定一些接口的輸入JSON數(shù)據(jù)和輸出JSON數(shù)據(jù),但是隨著項目的進度開展,這些數(shù)據(jù)結(jié)構(gòu)一直有所變化,那么我們模擬的JSON數(shù)據(jù)格式也需要協(xié)同變化,但是很不幸既然大家忙著開發(fā),接口協(xié)調(diào)的事情肯定優(yōu)先級沒那么高,即使每次記得協(xié)調(diào)接口數(shù)據(jù),也不一定能夠完全一致。
在Web API端也就是后端沒有完全做好的情況下,我們不可能給出所有接口的輸入輸出JSON格式,那么我們是否可以考慮采用折中模擬數(shù)據(jù)接口的方式來提供,并且能夠提供比較易讀、易維護的處理方式呢?答案是肯定有的,結(jié)合RAP2和Mock.js兩者的特點,可以較為方便的模擬出我們需要接口的URL、輸入?yún)?shù)、輸出參數(shù)等信息。
RAP2是一個Web接口管理工具,開源免費,接口自動化,MOCK數(shù)據(jù)自動生成,自動化測試,企業(yè)級管理。
Mock.js的出現(xiàn)解決了前端離開后端就沒法請求數(shù)據(jù)的問題,但也出現(xiàn)了新的問題,就是在切換生產(chǎn)環(huán)境的時候,模擬的數(shù)據(jù)可能和接口又發(fā)生不同步的情況。
RAP2是一個新的解決方案,將前端后端拉倒一個團隊倉庫中,共享一個倉庫,無論是URL地址,還是請求需要的參數(shù),在團隊倉庫中雙方都可以管理,并且可以記錄團隊成員修改了哪些接口,整合到生產(chǎn)環(huán)境的時候,可以比較完美的切換,同步性較好!
相關(guān)網(wǎng)站資源:
http://mockjs.com/ mock.js網(wǎng)址
http://rap2.taobao.org/ RAP2網(wǎng)址
https://github.com/thx/rap2-delos RAP2官方文檔
https://github.com/nuysoft/Mock/wiki/Syntax-Specification mock.js語法規(guī)范文檔
1、RAP2創(chuàng)建接口
打開網(wǎng)站http://rap2.taobao.org/ ,注冊一個用戶賬號,并創(chuàng)建自己的模塊和接口,如下所示

默認(rèn)有一個示例接口指引我們做相關(guān)的參數(shù)或者響應(yīng)內(nèi)容
對每個參數(shù),都可以使用Mock規(guī)則進行生成值,如下界面所示

除了示例,我們也可以創(chuàng)建自己的模塊和接口,如下所示我們創(chuàng)建一個用戶管理的模塊,以及兩個接口。
獲取用戶的接口定義如下所示。

這個URL地址是我們邏輯上的相對地址,實際在使用的時候,我們加上一個基地址就可以了,在RAP2 它也是一個相對地址,測試接口的地址也是加上一個基礎(chǔ)地址,這樣我們實際開發(fā)的時候,把這部分基礎(chǔ)地址替換為生產(chǎn)環(huán)境的地址即可順利切換過去了。

這個接口實際返回的JSON數(shù)據(jù)格式就是我們約定好的JSON格式了,如果我們有變化,大家參考這個中間的平臺就可以了,溝通時比較方便,也可以對比那些字段參數(shù)變化調(diào)整了,這樣前后端就有了一個參考的中間平臺,一致性較好。
2、接口參數(shù)定義和Mock變量使用
那么這些JSON數(shù)據(jù)是如何來的,我們其實是填寫了一些變量,讓它自動生成的數(shù)據(jù)的,這個也是Mock.js的功勞吧。RAP2集成了MockJS的很多變量使用,參考著使用就可以構(gòu)建很多不一樣的數(shù)據(jù),非常方便。
下面列出我的一些輸入、輸入的變量內(nèi)容。
輸入的參數(shù),定義如下:

響應(yīng)的輸出參數(shù)如下定義。

獲得的輸出自動生成的JSON數(shù)據(jù)如下所示。

這個就是我們使用Mock變量的好處,自動根據(jù)規(guī)則填充,上面我使用了各種變量來定義數(shù)據(jù),如果你需要了解Mock的變量,可以結(jié)合Mock的變量來測試即可。具體參考下面說明。
http://mockjs.com/examples.html
上面鏈接列出了Mock的兩項定義:數(shù)據(jù)模板定義和數(shù)據(jù)占位符定義,可以根據(jù)情況用不同的定義。我更側(cè)向于使用后者,方便快捷。
RAP2給前后端開發(fā)者一種更好更透明的協(xié)同開發(fā)方式,一個負(fù)責(zé)維護接口、一個負(fù)責(zé)參考修改調(diào)用,大家相互配合,其樂融融。
關(guān)于RAP2的功能好像還有很多,不過我們使用它最主要的目的是解決模擬API接口和協(xié)同性的問題,這個大原則是它的主要目的,基于RAP2和Mock.js的結(jié)合,我們可以解放頻繁溝通而得不到接口一致性問題的問題,從而實現(xiàn)更好從調(diào)試環(huán)境到生產(chǎn)環(huán)境的切換。
甚至更好的方案是我們 在Web API接口開發(fā)的初期,先花點功夫來定義好所有的接口輸入輸出,整理一個大家認(rèn)為比較好的接口規(guī)范后,再開始Web API的編碼,這樣肯定后期開發(fā)是事半功倍,而且前端也可以很快對接。