1. 程式人生 > >使用RAP2和Mock.JS實現Web API接口的數據模擬和測試

使用RAP2和Mock.JS實現Web API接口的數據模擬和測試

優先級 規則 web前端 Mock.JS 集成 鏈接 生產 微信 應用

最近一直在思考如何對Web API的其接口數據進行獨立開發的問題,隨著Web API的越來越廣泛應用,很多開發也要求前端後端分離,例如統一的Web API接口後,Winform團隊、Web前端團隊、微信小程序或者APP團隊大家可以同步開發,在最初約定一些接口的輸入JSON數據和輸出JSON數據,但是隨著項目的進度開展,這些數據結構一直有所變化,那麽我們模擬的JSON數據格式也需要協同變化,但是很不幸既然大家忙著開發,接口協調的事情肯定優先級沒那麽高,即使每次記得協調接口數據,也不一定能夠完全一致。

在Web API端也就是後端沒有完全做好的情況下,我們不可能給出所有接口的輸入輸出JSON格式,那麽我們是否可以考慮采用折中模擬數據接口的方式來提供,並且能夠提供比較易讀、易維護的處理方式呢?答案是肯定有的,結合RAP2和Mock.js兩者的特點,可以較為方便的模擬出我們需要接口的URL、輸入參數、輸出參數等信息。

RAP2是一個Web接口管理工具,開源免費,接口自動化,MOCK數據自動生成,自動化測試,企業級管理。

Mock.js的出現解決了前端離開後端就沒法請求數據的問題,但也出現了新的問題,就是在切換生產環境的時候,模擬的數據可能和接口又發生不同步的情況。

RAP2是一個新的解決方案,將前端後端拉倒一個團隊倉庫中,共享一個倉庫,無論是URL地址,還是請求需要的參數,在團隊倉庫中雙方都可以管理,並且可以記錄團隊成員修改了哪些接口,整合到生產環境的時候,可以比較完美的切換,同步性較好!

相關網站資源:

http://mockjs.com/ mock.js網址
http://rap2.taobao.org/ RAP2網址
https://github.com/thx/rap2-delos RAP2官方文檔
https://github.com/nuysoft/Mock/wiki/Syntax-Specification mock.js語法規範文檔

1、RAP2創建接口

打開網站http://rap2.taobao.org/ ,註冊一個用戶賬號,並創建自己的模塊和接口,如下所示

技術分享圖片

默認有一個示例接口指引我們做相關的參數或者響應內容

對每個參數,都可以使用Mock規則進行生成值,如下界面所示

技術分享圖片

除了示例,我們也可以創建自己的模塊和接口,如下所示我們創建一個用戶管理的模塊,以及兩個接口。

獲取用戶的接口定義如下所示。

技術分享圖片

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

技術分享圖片

這個接口實際返回的JSON數據格式就是我們約定好的JSON格式了,如果我們有變化,大家參考這個中間的平臺就可以了,溝通時比較方便,也可以對比那些字段參數變化調整了,這樣前後端就有了一個參考的中間平臺,一致性較好。

2、接口參數定義和Mock變量使用

那麽這些JSON數據是如何來的,我們其實是填寫了一些變量,讓它自動生成的數據的,這個也是Mock.js的功勞吧。RAP2集成了MockJS的很多變量使用,參考著使用就可以構建很多不一樣的數據,非常方便。

下面列出我的一些輸入、輸入的變量內容。

輸入的參數,定義如下:

技術分享圖片

響應的輸出參數如下定義。

技術分享圖片

獲得的輸出自動生成的JSON數據如下所示。

技術分享圖片

這個就是我們使用Mock變量的好處,自動根據規則填充,上面我使用了各種變量來定義數據,如果你需要了解Mock的變量,可以結合Mock的變量來測試即可。具體參考下面說明。

http://mockjs.com/examples.html

上面鏈接列出了Mock的兩項定義:數據模板定義和數據占位符定義,可以根據情況用不同的定義。我更側向於使用後者,方便快捷。

RAP2給前後端開發者一種更好更透明的協同開發方式,一個負責維護接口、一個負責參考修改調用,大家相互配合,其樂融融。
關於RAP2的功能好像還有很多,不過我們使用它最主要的目的是解決模擬API接口和協同性的問題,這個大原則是它的主要目的,基於RAP2和Mock.js的結合,我們可以解放頻繁溝通而得不到接口一致性問題的問題,從而實現更好從調試環境到生產環境的切換。

甚至更好的方案是我們 在Web API接口開發的初期,先花點功夫來定義好所有的接口輸入輸出,整理一個大家認為比較好的接口規範後,再開始Web API的編碼,這樣肯定後期開發是事半功倍,而且前端也可以很快對接。

使用RAP2和Mock.JS實現Web API接口的數據模擬和測試