完善

Former-commit-id: dd4c302e448f871376ab1298240b44aa3d3e1643 [formerly dd4c302e448f871376ab1298240b44aa3d3e1643 [formerly dd4c302e448f871376ab1298240b44aa3d3e1643 [formerly dd4c302e448f871376ab1298240b44aa3d3e1643 [formerly 8bbdd72ba63cd9161b2b2e51826b8813e8c9fffc [formerly e7d3090ad5a6f6801b32d0abce9a4e9291fcc0e7]]]]] Former-commit-id: 1be4f8ac464528598b8a52649c107686d01c08d8 Former-commit-id: 7317640b0da3a039d8ca5b6457c1263fc1261272 Former-commit-id: 29d4f7df0be48866f4309a012d38e008e1725438 [formerly 9ee9681b4a3200cc3b344673e83d9f5e4343f07a] Former-commit-id: fddc0694f8fbf921142069e11ff694ea218fa0d9 Former-commit-id: 92059d07f780aa09aaff77faf9bc41a8bd6269f0 Former-commit-id: aef5ddaf56545324913a9b425e7f8b7c3ed45518 Former-commit-id: 279be73fde5a48ddc78a258a2ea55a3b0d64fe2b Former-commit-id: b970cb8f0bbe694a3bf733e726f8c833a1f3f511
2018-07-17 14:33:33 +08:00
parent f67e14c3b9
commit 1ef066f47d
55 changed files with 2531 additions and 23 deletions
--- a/docs/zh/plugins/mock.md
+++ b/docs/zh/plugins/mock.md
@@ -0,0 +1,221 @@
+# 模拟数据
+
+在 `src/mock/demo/001.js` 配置拦截返回的数据
+
+## 使用
+
+``` js
+import Mock from 'mockjs'
+
+Mock.mock('/api/demo/001', {
+  'list|4-10': [{
+    'id|+1': 1,
+    'name': '@CNAME',
+    'star|1-5': '★',
+    'delFlag|1': [0, 1],
+    'creatDate': '@DATE',
+    'address': '@CITY',
+    'zip': '@ZIP'
+  }]
+})
+```
+
+请求数据
+
+``` js
+ajax () {
+  this.$axios.get('/api/demo/001')
+  .then(res => {
+    this.table.columns = Object.keys(res.data.list[0]).map(e => ({
+      label: e,
+      prop: e
+    }))
+    this.table.data = res.data.list
+  })
+}
+```
+
+## mock 语法规范
+
+Mock.js 的语法规范包括两部分：
+
+1. 数据模板定义规范（Data Template Definition，DTD）
+2. 数据占位符定义规范（Data Placeholder Definition，DPD）
+
+### 数据模板定义规范 DTD
+
+**数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：**
+
+``` js
+// 属性名   name
+// 生成规则 rule
+// 属性值   value
+'name|rule': value
+```
+
+**注意：**
+
+* _属性名_ 和 _生成规则_ 之间用竖线 `|` 分隔。
+* _生成规则_ 是可选的。
+* _生成规则_ 有 7 种格式：
+    1. `'name|min-max': value`
+    1. `'name|count': value`
+    1. `'name|min-max.dmin-dmax': value`
+    1. `'name|min-max.dcount': value`
+    1. `'name|count.dmin-dmax': value`
+    1. `'name|count.dcount': value`
+    1. `'name|+step': value`
+* **_生成规则_ 的 含义 需要依赖 _属性值的类型_ 才能确定。**
+* _属性值_ 中可以含有 `@占位符`。
+* _属性值_ 还指定了最终值的初始值和类型。
+
+<!-- 感谢 @麦少 同学对 Mock.js 语法的整理和分析，才有了这版相对清晰的语法文档。 -->
+
+**生成规则和示例：**
+
+#### 1. 属性值是字符串 **String**
+
+1. `'name|min-max': string` 
+
+    通过重复 `string` 生成一个字符串，重复次数大于等于 `min`，小于等于 `max`。
+
+2. `'name|count': string` 
+
+    通过重复 `string` 生成一个字符串，重复次数等于 `count`。
+
+#### 2. 属性值是数字 **Number**
+
+1. `'name|+1': number` 
+
+    属性值自动加 1，初始值为 `number`。
+
+2. `'name|min-max': number` 
+
+    生成一个大于等于 `min`、小于等于 `max` 的整数，属性值 `number` 只是用来确定类型。
+
+3. `'name|min-max.dmin-dmax': number` 
+
+    生成一个浮点数，整数部分大于等于 `min`、小于等于 `max`，小数部分保留 `dmin` 到 `dmax` 位。
+
+``` js
+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
+}
+```
+
+#### 3. 属性值是布尔型 **Boolean**
+
+1. `'name|1': boolean` 
+
+    随机生成一个布尔值，值为 true 的概率是 1/2，值为 false 的概率同样是 1/2。
+
+2. `'name|min-max': value` 
+
+    随机生成一个布尔值，值为 `value` 的概率是 `min / (min + max)`，值为 `!value` 的概率是 `max / (min + max)`。
+
+#### 4. 属性值是对象 **Object**
+
+1. `'name|count': object`
+
+    从属性值 `object` 中随机选取 `count` 个属性。
+
+2. `'name|min-max': object`
+
+    从属性值 `object` 中随机选取 `min` 到 `max` 个属性。
+
+#### 5. 属性值是数组 **Array**
+
+1. `'name|1': array` 
+
+    从属性值 `array` 中随机选取 1 个元素，作为最终值。
+
+2. `'name|+1': array` 
+
+    从属性值 `array` 中顺序选取 1 个元素，作为最终值。
+
+3. `'name|min-max': array` 
+
+    通过重复属性值 `array` 生成一个新数组，重复次数大于等于 `min`，小于等于 `max`。
+
+4. `'name|count': array` 
+
+    通过重复属性值 `array` 生成一个新数组，重复次数为 `count`。
+
+#### 6. 属性值是函数 **Function**
+
+1. `'name': function` 
+
+    执行函数 `function`，取其返回值作为最终的属性值，函数的上下文为属性 `'name'` 所在的对象。
+
+#### 7. 属性值是正则表达式 **RegExp**
+
+1. `'name': regexp` 
+
+    根据正则表达式 `regexp` 反向生成可以匹配它的字符串。用于生成自定义格式的字符串。
+
+    ``` js
+    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"
+    }
+    ```
+
+### 数据占位符定义规范 DPD
+
+_占位符_ 只是在属性值字符串中占个位置，并不出现在最终的属性值中。
+
+_占位符_ 的格式为：
+
+```
+@占位符
+@占位符(参数 [, 参数])
+```
+
+**注意：**
+
+1. 用 `@` 来标识其后的字符串是 _占位符_。
+2. _占位符_ 引用的是 `Mock.Random` 中的方法。
+3. 通过 `Mock.Random.extend()` 来扩展自定义占位符。
+4. _占位符_ 也可以引用 _数据模板_ 中的属性。
+5. _占位符_ 会优先引用 _数据模板_ 中的属性。
+6. _占位符_ 支持 _相对路径_ 和 _绝对路径_。
+
+``` js
+Mock.mock({
+    name: {
+        first: '@FIRST',
+        middle: '@FIRST',
+        last: '@LAST',
+        full: '@first @middle @last'
+    }
+})
+// =>
+{
+    "name": {
+        "first": "Charles",
+        "middle": "Brenda",
+        "last": "Lopez",
+        "full": "Charles Brenda Lopez"
+    }
+}
+```
+
+
+