Mockjs示例API整理 – 源码巴士

数据模板定义

String字符型

'name|min-max': string
'name|repeat': string

Number数字型

'name|+1': number
'name|min-max': number
'name|min-max.dmin-dmax': number
>>
Mock.mock({
  "number|123.10": 1.123
})

Boolean布尔型

'name|1': boolean
'name|min-max': boolean

Object对象

'name|count': object
>>
Mock.mock({
  "object|2": {
    "310000": "上海市",
    "320000": "江苏省",
    "330000": "浙江省",
    "340000": "安徽省"
  }
})

'name|min-max': object
>>
Mock.mock({
  "object|2-4": {
    "110000": "北京市",
    "120000": "天津市",
    "130000": "河北省",
    "140000": "山西省"
  }
})

Array数组

'name|1': array
'name|+1': array
>>
Mock.mock({
  "array|+1": [
    "AMD",
    "CMD",
    "UMD"
  ]
})

'name|min-max': array
>>
Mock.mock({
  "array|1-10": [
    "Hello",
    "Mock.js",
    "!"
  ]
})

'name|count': array
>>
Mock.mock({
  "array|3": [
    "Hello",
    "Mock.js",
    "!"
  ]
})

Function函数

'name': function
>>
Mock.mock({
  'foo': 'Syntax Demo',
  'name': function() {
    return this.foo
  }
})

RegExp正则表达式

'name': regexp
>>
Mock.mock({
  'regexp|1-5': /\d{5,10}\-/
})

Path路径

支持绝对路径与相对路径，表示的是已存在数据中的路径
Mock.mock({
  "foo": "Hello",
  "nested": {
    "a": {
      "b": {
        "c": "Mock.js"
      }
    }
  },
  "absolutePath": "@/foo @/nested/a/b/c"
})

Mock.mock({
  "foo": "Hello",
  "nested": {
    "a": {
      "b": {
        "c": "Mock.js"
      }
    }
  },
  "relativePath": {
    "a": {
      "b": {
        "c": "@../../../foo @../../../nested/a/b/c"
      }
    }
  }
})

数据占位符定义

Basic基础类型

Random.boolean( min?, max?, current? )
>>
Random.boolean(1, 9, true)
Mock.mock('@boolean(1, 9, true)')

Random.natural( min?, max? )
>>
Random.natural(60, 100)
Mock.mock('@natural(60, 100)')

Random.integer( min?, max? )
>>
Random.integer(60, 100)
Mock.mock('@integer(60, 100)')

Random.float( min?, max?, dmin?, dmax? )
>>
Random.float(60, 100, 3, 5)
Mock.mock('@float(60, 100, 3, 5)')

Random.character( pool? )
>>
Random.character('aeiou')
Mock.mock('@character("aeiou")')

Random.string( pool?, min?, max? )
>>
Random.string('aeiou', 1, 3)
Mock.mock('@string("aeiou", 1, 3)')

Random.range(start?, stop, step?)
>>
Random.range(1, 10, 3)
Mock.mock('@range(1, 10, 3)')

Date日期类型

Random.date( format? )
>>
Random.date('yyyy-MM-dd')
Mock.mock('@date("yyyy yy y MM M dd d")')

Random.time( format? )
>>
Random.time('A HH:mm:ss')
Mock.mock('@datetime("HH H hh h mm m ss s SS S A a T")')

Random.datetime( format? )
>>
Random.datetime('yyyy-MM-dd A HH:mm:ss')
Mock.mock('@datetime("yyyy yy y MM M dd d HH H hh h mm m ss s SS S A a T")')

Random.now( unit?, format? )
>>
Random.now('day', 'yyyy-MM-dd HH:mm:ss SS')

Image图像图片

Random.image( size?, background?, foreground?, format?, text? )
>>
Random.image('200x100', '#894FC4', '#FFF', 'png', '!')

Random.dataImage( size?, text? )
>>
Random.dataImage('200x100', 'Hello Mock.js!')

Color颜色值

Random.color()
>>
Random.color()
Mock.mock('@color')
Mock.mock('@color()')

Random.hex()
>>
Random.hex()
Mock.mock('@hex')
Mock.mock('@hex()')

Random.rgb()
>>
Random.rgb()
Mock.mock('@rgb')
Mock.mock('@rgb()')

Random.rgba()
>>
Random.rgba()
Mock.mock('@rgba')
Mock.mock('@rgba()')

Random.hsl()
>>
Random.hsl()
Mock.mock('@hsl')
Mock.mock('@hsl()')

Text文本

Random.paragraph( min?, max? )
>>
Random.paragraph(1, 3)
Mock.mock('@paragraph(1, 3)')

Random.sentence( min?, max? )
>>
Random.sentence(3, 5)
Mock.mock('@sentence(3, 5)')

Random.word( min?, max? )
>>
Random.word(3, 5)
Mock.mock('@word(3, 5)')

Random.title( min?, max? )
>>
Random.title(3, 5)
Mock.mock('@title(3, 5)')

Random.cparagraph( min?, max? )
>>
Random.cparagraph(1, 3)
Mock.mock('@cparagraph(1, 3)')

Random.csentence( min?, max? )
>>
Random.csentence(3, 5)
Mock.mock('@csentence(3, 5)')

Random.cword( pool?, min?, max? )
>>
Random.cword('零一二三四五六七八九十', 5, 7)
Mock.mock('@cword("零一二三四五六七八九十", 5, 7)')

Random.ctitle( min?, max? )
>>
Random.ctitle(3, 5)
Mock.mock('@ctitle(3, 5)')

Name名姓相关

Random.first()
>>
Random.first()
Mock.mock('@first')
Mock.mock('@first()')

Random.last()
>>
Random.last()
Mock.mock('@last')
Mock.mock('@last()')

Random.name( middle? )
>>
Random.name(true)
Mock.mock('@name(true)')

Random.cfirst()
>>
Random.cfirst()
Mock.mock('@cfirst')
Mock.mock('@cfirst()')

Random.clast()
>>
Random.clast()
Mock.mock('@clast')
Mock.mock('@clast()')

Random.cname()
>>
Random.cname()
Mock.mock('@cname')
Mock.mock('@cname()')

Web网络相关

Random.url()
>>
Random.url()
Mock.mock('@url')
Mock.mock('@url()')

Random.domain()
>>
Random.domain()
Mock.mock('@domain')
Mock.mock('@domain()')

Random.protocol()
>>
Random.protocol()
Mock.mock('@protocol')
Mock.mock('@protocol()')

Random.tld()
>>
Random.tld()
Mock.mock('@tld')
Mock.mock('@tld()')

Random.email()
>>
Random.email()
Mock.mock('@email')
Mock.mock('@email()')

Random.ip()
>>
Random.ip()
Mock.mock('@ip')
Mock.mock('@ip()')

Address地址

Random.region()
>> 地域
Random.region()
Mock.mock('@region')
Mock.mock('@region()')

Random.province()
>> 省份
Random.province()
Mock.mock('@province')
Mock.mock('@province()')

Random.city( prefix? )
>> (省)市
Random.city(true)
Mock.mock('@city(true)')

Random.county( prefix? )
>> (省市)区
Random.county(true)
Mock.mock('@county(true)')

Random.zip()
>> 区号
Random.zip()
Mock.mock('@zip')
Mock.mock('@zip()')

Helper帮助类

Random.capitalize( word )
>> 首字母大写
Random.capitalize('hello')
Mock.mock('@capitalize("hello")')

Random.upper( str )
>> 转大写
Random.upper('hello')
Mock.mock('@upper("hello")')

Random.lower( str )
>> 转小写
Random.lower('HELLO')
Mock.mock('@lower("HELLO")')

Random.pick( arr )
>> 
Random.pick(['a', 'e', 'i', 'o', 'u'])
Mock.mock('@pick(["a", "e", "i", "o", "u"])')

Random.shuffle( arr )
>> 
Random.shuffle(['a', 'e', 'i', 'o', 'u'])
Mock.mock('@shuffle(["a", "e", "i", "o", "u"])')

Miscellaneous杂项

Random.guid()
>>
Random.guid()
Mock.mock('@guid')
Mock.mock('@guid()')

Random.id()
>>
Random.id()
Mock.mock('@id')
Mock.mock('@id()')

Random.increment( step? )
>>
Random.increment(100)
Mock.mock('@increment(100)')