Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jiadi0801/mock-yaml
用简洁的yaml语法写mock文件，告别繁杂的json引号
https://github.com/jiadi0801/mock-yaml
mockjs yaml
Last synced: about 2 months ago
JSON representation
用简洁的yaml语法写mock文件，告别繁杂的json引号
- Host: GitHub
- URL: https://github.com/jiadi0801/mock-yaml
- Owner: jiadi0801
- Created: 2017-06-20T08:32:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-08-07T03:42:27.000Z (over 7 years ago)
- Last Synced: 2024-12-06T14:17:34.226Z (2 months ago)
- Topics: mockjs, yaml
- Language: JavaScript
- Homepage: http://jiadi0801.github.io/convert.html
- Size: 223 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
Awesome Lists containing this project
README
# mock-yaml
用yaml语法作为数据结构，兼容绝大部分[mockjs](https://github.com/nuysoft/Mock)语法，同时获得yaml的强大扩展能力。
## 安装
服务端npm安装
```
$ npm install mock-yaml --save-dev
```
客户端引入script脚本
```
```
## 使用
### 使用示例
见[how to use](https://github.com/jiadi0801/mock-yaml/blob/master/doc/howtouse.md)
### 方法
* toJSON: 将yaml文件转成json
* toYAML: 将json转成yaml，暂不支持mockjs规则自动转成yaml语法的规则
* Random: 扩展mockjs的占位符，也即Mock.Random
* Mock: mockjs对象
## 相关文档
* [阮一峰yaml介绍](http://www.ruanyifeng.com/blog/2016/07/yaml.html)
* [js-yaml](http://nodeca.github.io/js-yaml/)
* [mockjs示例](http://mockjs.com/examples.html)
## TODO
* [todo] xhr mock，增强且覆盖尽可能多的库
* [todo] 增加mock占位符
* [todo] 转换器页面增加链接到GitHub主页
## mockjs模板在mock-yaml的语法
```
属性：规则模板 具体规则 初始值
key: !str/min-max 1-3 ★
```
## mockjs数据模板
|类型 | mockjs数据模板 | mock-yaml示例语法 | 示例结果 | 备注 |
|------------------|---------------------|---------------------------|-------------------|-------|
|string | min-max | key: !str/min-max 1-3 ★ | {key: "★★"} | |
|string | count | key: !str/count 4 ★ | {key: "★★★★"} | |
|number | min-max | key: !num/min-max -10-10 1| {key: -3} | |
|number | min-max.dmin-dmax | key: !num/min-max.dmin-dmax 1-10.2-3 10 | {key: 9.77} | |
|number | min-max.dcount | key: !num/min-max.dcount 1-10.3 1 | {key: 1.104} | |
|number | count.dmin-dmax | key: !num/count.dmin-dmax -30.1-2 1 | {key: -30.9} | |
|number | count.dcount | key: !num/count.dcount -23.4 1 | {key: -23.7824} | |
|number | count | | | 没有实现 |
|number | +step | | | 没有实现 |
|boolean | 1 | key: !bool/1 | {key: false} | 可以只写规则模板!bool/1，不用写具体规则和初始值|
|boolean | min-max | key: !bool/min-max 1-3 true | {key: false} | |
|object | count | | | 见示例 |
|object | min-max | | | 见示例 |
|array | 1 | | | 见示例 |
|array | +1 | | | 没有实现 |
|array | min-max | | | 见示例 |
|array | count | | | 见示例 |
|function | !!js/function > | | | yaml内置 |
|regexp | | | | 见示例 |
|regexp | min-max | | | 没有实现 |
## mockjs占位符
|类型 | 占位符 | 兼容(default Y) | 备注 |
|------------------|-------------------|------------|-------|
|all | all | Y | |
## 注意事项
yml语法的`@`字符已被保留，所以如果存在以`@`为首字母的字符串（比如说mockjs的占位符），那么需要用引号将其包裹起来，如果`@`不是首字母，那么可以省略引号。
``` yaml
placeholder:
- '@url'
- hello @string(5,10)
```
## 示例
* file.yml
```yaml
root:
str:
-10--1: !str/min-max -10--1 ★
1-10: !str/min-max 1-10 ★
4: !str/count 4 ★
number:
-10-10: !num/min-max -10-10 1
1-10.2-3: !num/min-max.dmin-dmax 1-10.2-3 10
-10-1.1-4: !num/min-max.dmin-dmax -10-1.1-4 10
1-10.3: !num/min-max.dcount 1-10.3 1
1-10.-3: !num/min-max.dcount 1-10.-3 1
-30.1-2: !num/count.dmin-dmax -30.1-2 1
-23.4: !num/count.dcount -23.4 1
boolean:
anychar: !bool/1 1 1
true1-3: !bool/min-max 1-3 true
false1-3: !bool/min-max 1-3 false
object:
2: &aliasobj1 !object/count
/rule: 2
310000: 北京市
320000: 江苏省
330000: 浙江省
340000: 安徽省
1-3: &aliasobj2 !object/count
/rule: 1-3
310000: 北京市
320000: 江苏省
330000: 浙江省
340000: 安徽省
array:
1-3: !array/min-max &alias1
- 1-3
- 北京市
- 江苏省
- 浙江省
- 安徽省
2: !array/count
- 2
- 北京市
- 江苏省
- 浙江省
- 安徽省
func: !!js/function >
function foobar() {
return 'Wow! JS-YAML Rocks!';
}
regexp:
- !regexp/1 /[a-z][A-Z][0-9]/
- !regexp/1 /\w\W\s\S\d\D/
- !regexp/1 /\d{5,10}/
- !regexp/1 /@color/
placeholder:
- '@check'
- '@url'
- hello @string(5,10)
- '@now'
alias: *alias1
aliasobj:
<<: *aliasobj1
<<: *aliasobj2
```
* json
```json
{
"root": {
"str": {
"4": "★★★★",
"-10--1": "",
"1-10": "★★★★★★★"
},
"number": {
"-10-10": 2,
"1-10.2-3": 9.361,
"-10-1.1-4": -8.07,
"1-10.3": 2.412,
"1-10.-3": 8.6158,
"-30.1-2": -30.37,
"-23.4": -23.9829
},
"boolean": {
"anychar": false,
"true1-3": false,
"false1-3": false
},
"object": {
"2": {
"310000": "北京市",
"320000": "江苏省"
},
"1-3": {
"310000": "北京市",
"330000": "浙江省",
"340000": "安徽省"
}
},
"array": {
"2": [
"北京市",
"江苏省",
"浙江省",
"安徽省",
"北京市",
"江苏省",
"浙江省",
"安徽省"
],
"1-3": [
"北京市",
"江苏省",
"浙江省",
"安徽省",
"北京市",
"江苏省",
"浙江省",
"安徽省"
]
},
"regexp": [
"fG8",
"V@
u1\"",
"54677466",
"#79f2af"
],
"placeholder": [
"extend success",
"tn3270://vdqsmnf.sa/weo",
"hello GmFmah",
"2017-06-21 22:42:15"
],
"alias": [
"北京市",
"江苏省",
"浙江省",
"安徽省",
"北京市",
"江苏省",
"浙江省",
"安徽省"
],
"aliasobj": {
"310000": "北京市",
"320000": "江苏省",
"330000": "浙江省",
"340000": "安徽省"
},
"func": "Wow! JS-YAML Rocks!"
}
}
```