12.25 使用RAP2和Mock.JS实现Web API接口的数据模拟和测试

Rap2是来在于阿里妈妈团队的开源项目，它能给你提供方便的接口文档管理、Mock、导出等功能，包含两个组件(对应两个 Github Repository)。

rap2-delos: 后端数据 API 服务器，基于 Koa + MySQLlink rap2-dolores: 前端静态资源，基于 React link Rap 官方服务站点，无需安装直接体验: rap2.taobao.org

相关概念仓库：即接口文档放置的仓库，可以包含多个接口文档协同仓库：Mock服务协同仓库，在当前仓库中无法匹配到接口时，将会从协同仓库中寻找，便于大的项目按不同仓库拆分管理团队：团队可包含多个仓库，用户可加入多个团队插件：用于实现生成Mock数据、拦截真实I/O请求以Mock数据替换等功能的插件平台API：以开放API形式将接口文档、Mock数据等内容，提供给外部调用 Mock模板：Mock.js规则模板，用于生成Mock数据，模板中可定义丰富的规则以适应数据的按需随机性 Mock数据：通过Mock模板生成的最终Mock数据配置方式 RAP2使用了Mock.js作为Mock引擎，详细语法规则请参考mockjs.com。在请求Mock服务时，RAP2将通过文档信息生成 Mock.js模板，最后再转为Mock.js数据。

数据模板定义数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：

// 属性名 name // 生成规则 rule // 属性值 value 'name|rule': value 注意：

属性名和生成规则之间用竖线 | 分隔。

生成规则是可选的。

生成规则

有 7 种格式：

'name|min-max': value
'name|count': value
'name|min-max.dmin-dmax': value
'name|min-max.dcount': value
'name|count.dmin-dmax': value
'name|count.dcount': value
'name|+step': value

生成规则 的含义需要依赖 属性值的类型 才能确定。

属性值中可以含有 @占位符。

属性值还指定了最终值的初始值和类型。

生成规则和示例

属性值是字符串 String 'name|min-max': string

通过重复 string 生成一个字符串，重复次数大于等于 min，小于等于 max。

'name|count': string

通过重复 string 生成一个字符串，重复次数等于 count。

属性值是数字 Number 'name|+1': number

属性值自动加 1，初始值为 number。

'name|min-max': number

生成一个大于等于 min、小于等于 max 的整数，属性值 number 只是用来确定类型。

'name|min-max.dmin-dmax': number

生成一个浮点数，整数部分大于等于 min、小于等于 max，小数部分保留 dmin 到 dmax 位。

Mock.mock({
    'number1|1-100.1-10': 1,
    'number2|123.1-10': 1,
    'number3|123.3': 1,
    'number4|123.10': 1.123
})
// =>
{
    "number1": 12.92,
    "number2": 123.51,
    "number3": 123.777,
    "number4": 123.1231091814
}

属性值是布尔型 Boolean 'name|1': boolean

随机生成一个布尔值，值为 true 的概率是 1/2，值为 false 的概率同样是 1/2。

'name|min-max': value

随机生成一个布尔值，值为 value 的概率是 min / (min + max)，值为 !value 的概率是 max / (min + max)。

属性值是对象 Object 'name|count': object

从属性值 object 中随机选取 count 个属性。

'name|min-max': object

从属性值 object 中随机选取 min 到 max 个属性。

属性值是数组 Array 'name|1': array

从属性值 array 中随机选取 1 个元素，作为最终值。

'name|+1': array

从属性值 array 中顺序选取 1 个元素，作为最终值。

'name|min-max': array

通过重复属性值 array 生成一个新数组，重复次数大于等于 min，小于等于 max。

'name|count': array

通过重复属性值 array 生成一个新数组，重复次数为 count。

属性值是函数 Function 'name': function

执行函数 function，取其返回值作为最终的属性值，函数的上下文为属性 'name' 所在的对象。

属性值是正则表达式 RegExp 'name': regexp

根据正则表达式 regexp 反向生成可以匹配它的字符串。用于生成自定义格式的字符串。

Mock.mock({
    'regexp1': /[a-z][A-Z][0-9]/,
    'regexp2': /\w\W\s\S\d\D/,
    'regexp3': /\d{5,10}/
})
// =>
{
    "regexp1": "pJ7",
    "regexp2": "F)\fp1G",
    "regexp3": "561659409"
}

8.数据占位符占位符只是在属性值字符串中占个位置，并不出现在最终的属性值中。

占位符的格式为：

@占位符 @占位符(参数 [, 参数]) 注意：

用 @ 来标识其后的字符串是占位符。占位符引用的是 Mock.Random 中的方法。通过 Mock.Random.extend() 来扩展自定义占位符。占位符也可以引用数据模板中的属性。占位符会优先引用数据模板中的属性。占位符支持相对路径和绝对路径。

Mock.mock({
    name: {
        first: '@FIRST',
        middle: '@FIRST',
        last: '@LAST',
        full: '@first @middle @last'
    }
})
// =>
{
    "name": {
        "first": "Charles",
        "middle": "Brenda",
        "last": "Lopez",
        "full": "Charles Brenda Lopez"
    }
}

9.引用请求参数在初始值中填写$参数名$，RAP2 Mock服务会根据实际的传参将其替换为实际传入值。例如字段param填写初始值$xxx$，当收到请求url?xxx=123时，实际返回值为{ "param": "123" }

调用方式根据rap2提供的接口，获取业务调用接口的数据如下：

http://IP:PORT/app/mock/:repositoryId/:url

:repositoryId：指的是接口所在仓库的id

:url：接口的url

参考：

rap2用户手册

mockjs示例

mockjs语法规范

vieyahn2017 / iBlog

12.25 使用RAP2和Mock.JS实现Web API接口的数据模拟和测试 #382

使用RAP2和Mock.JS实现Web API接口的数据模拟和测试