mock和RAP入门教程

在很早以前公司里面就接入了rap在线管理接口文档平台,通过图形化书写接口文档,给前端同事使用。但是之前也仅仅是用于写接口文档,从来没有研究过它还有其他用途。最近与自己合作的一个前端同事说,你为啥不利用好rap来写接口文档,它会自动生成mock数据,我们就不用将rap默认生成的数据修改后,再本地测试一下。弄完之后再与你们联调。今儿就花了2个小时左右研究一下rap,顺藤摸瓜出来mock。下面简单介绍一下,mock以及如何在rap中使用mock,生成比较好的模拟数据,提高前后端协作效率。

mock.js[1]

mock.js随机生成数据,让前端开发人员在开发阶段时独立于后端,使用mockjs可以自测代码。

语法规范

  • 数据模板定义规范(DTD:Data Template Definition)
  • 数据占位符规范(DPD: Data Placeholder definition)

数据模板定义规范

格式

'name|rule':value (属性名|生成规则:属性值),其中生成规则是可选的

生成规则

  • 7种生成规则

    1. 'name|min-max':value
    2. 'name|count':value
    3. 'name|min-max.dmin-dmax':value
    4. 'name|+step':value
    5. 'name|min-max.dcount':value
    6. 'name|count.dmin-dmax':value
    7. 'name|count.dcount':value
  • 生成规则的含义依赖属性值的类型才能确认,这一点特别重要。也是mock的关键所在。
    比如:

    • 'name|min-max':string: 通过重复[min,max]次string生成新字符串。
    • 'name|min-max':number: 生成一个number,返回在[min,max]。

属性值

  1. 属性值可含@(占位符)
  2. 指定最终的值和类型
  3. 属性值类型
    • String
    • Number
    • Boolean
    • Object
    • Array
    • Function
    • RegExp
    • Path

学过js看着十分简单,只是多了RegExp 和 Path,其他简直一模一样。

数据占位符定义规范DPD

占位符

1.占位符只是在属性字符串中占个位置,并不出现在最终的属性值中
2.格式:@占位符或者@占位符(参数[,参数])
3.占位符

  • 用@标识后面的字符串是占位符
  • 引用的是Mock.Random中的方法
  • 扩展定义占位符:Mock.Random.extend()
  • 引用数据模板中的属性
  • 支持相对路径和绝对路径

4.数据占位符类型
数据占位符一共有如下几种类型:

  • Basic
  • Date
  • Image
  • Color
  • Text
  • Name
  • Web
  • Address
  • Helper
  • Miscellaneous

具体mock语法示例,请参考mock示例[2],里面详细的介绍了各个类型使用方法。

rap写接口文档中运用mock[3]

什么是rap

RAP是前后端沟通桥梁的通信接口,是一个图形化的接口文档管理的软件。它可以自动生成mock数据,在开发时候前端同事可以不依赖于后端的数据,而是根据mock规则自动生成的模拟数据进行测试。

rap.jpg

怎么在rap中是使用mock

有很多资料,且是图文并茂写博文[4][5]。总结起来,在rap中运用mock方法如下:

  • 左边变量写 name|rule,此处相当于就是mock中的'name|rule';
  • 右边备注写 @mock=value。其语法规则mock一样。

参考


  1. https://github.com/nuysoft/Mock/wiki

  2. http://mockjs.com/examples.html

  3. https://github.com/thx/RAP/wiki/

  4. http://www.imooc.com/article/17588

  5. http://blog.sina.com.cn/s/blog_c00ccc680102x0ue.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容