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

来源:https://www.cnblogs.com/wuhuacong/archive/2019/01/03/10213540.html
-Advertisement-
Play Games

最近一直在思考如何對Web API的其介面數據進行獨立開發的問題,隨著Web API的越來越廣泛應用,很多開發也要求前端後端分離,例如統一的Web API介面後,Winform團隊、Web前端團隊、微信小程式或者APP團隊大家可以同步開發,在最初約定一些介面的輸入JSON數據和輸出JSON數據,但是... ...


最近一直在思考如何對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的編碼,這樣肯定後期開發是事半功倍,而且前端也可以很快對接。

 
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • > startapp rbac models.py from django.db import models class User(models.Model): name=models.CharField(max_length=32) pwd=models.CharField(max_length= ...
  • 一、模塊 模塊就是一個包含了python定義和申明的文件,文件名就是模塊的名字加上.py的尾碼/ 模塊的分類: 1、使用python編寫的py文件 2、已被編譯位共用庫或者DLL或C或者C++的擴展 3、包好一組模塊的包 4、使用c編寫並連接到python解釋器的內置模塊 使用模塊是為了讓我們寫的代 ...
  • 設計2個類,要求如下: (知識點:類的繼承 方法的覆蓋)1、定義一個汽車類Vehicle, 1.1 屬性包括:汽車品牌brand(String類型)、顏色color(String類型 )和速度speed(double類型)。 1.2 至少提供一個有參的構造方法(要求品牌和顏色可以初始化為任意值 ,但 ...
  • 一. c/s 架構: 客戶端(client)/服務端(server)架構 服務端: 提供服務的 客戶端: 享受服務的 B/S 架構:瀏覽器(browser)/服務端(server) 軟體cs架構:瀏覽器,qq,微信,陌陌等等 硬體cs架構: 印表機 製圖工具: visio, powerdesigne ...
  • 今天偶然遇見使用easyUI時,彈窗和分頁都是亂碼的問題,耗費了很長的時間來解決,以此記住這個坑。 相信大家都會在使用easyUI時都會設置這樣一句: 那麼就有可能出現設置中文後的亂碼問題,如下圖: 因為在使用easyUI時大家都是進行拷貝文件,無法保證拷貝的js文件的編碼格式,所以就應該檢查一下e ...
  • 上一篇文章基於jTopo的拓撲圖設計工具庫ujtopo,介紹了拓撲設計工具,這一篇我們使用SignalR2結合ujtopo實現拓撲圖的動態變化。 僅僅作為演示,之前的文章SignalR2簡易數據看板演示,用一個小的示例演示了SignalR作為數據看板的用法,這次我們將這個例子稍微改變一下,當點擊【數 ...
  • 轉發請註明此文章作者與路徑,請尊重原著,違者必究。 本篇文章與其它系列文章不同,為了方便測試,新建了一個ASP.Net Core視圖應用。 備註:下麵說的應用,只是在容器中運行的應用程式。 查看現在運行的應用 容器中已經運行了一個應用testaspnetcoredockerlinuxname,版本是 ...
  • 前言: 第一次接觸ABP的項目是在2018年6月份,但是當時沒有深入具體的研究,而今天因為工作的需要,需要學習、瞭解這個框架,在時隔半年之後,今天重新下載了這個項目,雖然在園子里有很多前輩們寫的這類的文章,但是我還是會在博客園中記錄一下學習的過程,一是希望能夠幫助到有需要的人,二是也算是自己學習的一 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...