schema-generator

在开发模块时，我们需要做一些配置的工作，一般都是先编写scema文件，再编写mock数据。其实这2个工作有一点重复，我们可以从mock数据结构中反推出schema结构，自动生成。

schema生成器就是用来解决这个问题，它可以帮助开发者从繁杂的schema编写工作中解放出来，配置越复杂，提升的效率也就越高，尤其是针对schema不熟悉的同学。

使用

安装schema生成器

$ tnpm i -g @ali/schema-generator

通过命令行进行使用

schema -m ./mock.json -s ./schema.json

title

因为mock数据只包换了具体的字段名和数据，所以schema的title字段无法自动生成，默认使用的是字段名。

但是，在生成器中也定义了一些通用的标题映射，通过在命令行中添加title参数进行使用

schema -m ./mock.json -s ./schema.json --title

default

如果schema需要有默认值的话，可以在命令行中添加default参数

schema -m ./mock.json -s ./schema.json --default

注意

在定义字段名时要用驼峰式，并且要尽量简单，比如商品标题不要用item_title, 而是用itemTitle，但最佳的方案是title，这样在自动映射标题的更有可能被匹配上。

在编写mock数据的时候也要遵守shema本身的一些规范，比如：

• 不要直接在一级json中直接编写具体的配置字段。

# wrong
{
  "id": 1,
  "title": "hello",
  "price": 12
}

# right
{
  "item": {
    "id": 1,
    "title": "hello",
    "price": 12
  }
}

• 在数组中只能放对象，而且不要为空

# wrong
{
  "items": [1, 2, 3]
}

# wrong
{
  "items": []
}

# wrong
{
  "items": [
    [
      {id: 1}
    ]
  ]
}

# right
{
  "items": [
    {"id": 1},
    {"id": 2},
    {"id": 3}
  ]
}

也可以通过vscode插件进行使用

1. 在vscode插件市场搜索schema-generator并安装

2. 右键mock文件，选择schema生成器菜单即可

demo

mock.json

{
  "config": {
    "title": "2月22日准点来拿, 务必赚够闲鱼币哦！",
    "items": [
      {
        "img": "https://gw.alicdn.com/tfs/TB1UJtvu1L2gK0jSZFmXXc7iXXa-350-350.png",
        "title": "iPhoneXS MAX一部",
        "price": "5000万",
        "date": "2月22日来拿",
        "id": 1
      },
      {
        "img": "https://gw.alicdn.com/tfs/TB1.MVuu5_1gK0jSZFqXXcpaXXa-350-350.png",
        "title": "蓝漂4包本色抽纸",
        "price": "2000",
        "date": "2月22日来拿",
        "name": "2j"
      },
      {
        "img": "https://gw.alicdn.com/tfs/TB11phtu.T1gK0jSZFhXXaAtVXa-350-350.png",
        "title": "闲鱼金条5g",
        "price": "1000起拍",
        "date": "2月22日来拿"
      },
      {
        "img": "https://gw.alicdn.com/tfs/TB11FFwu.Y1gK0jSZFCXXcwqXXa-350-350.png",
        "title": "迪士尼家庭门票",
        "price": "100000",
        "date": "2月22日来拿",
        "time": "121212"
      }
    ],
    "sceneCode": "IDLECOINDAY",
    "url": "https://market.m.taobao.com/app/idleFish-F2e/idlefish-xycoin/pages/index?wh_weex=true",
    "successTip": "预约成功，2月22日来领吗"
  }
}

schema.json

{
  "title": "Schema",
  "type": "object",
  "properties": {
    "config": {
      "title": "config",
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "title": "title"
        },
        "items": {
          "title": "items",
          "type": "array",
          "items": {
            "title": "items_item",
            "type": "object",
            "properties": {
              "img": {
                "type": "string",
                "title": "img"
              },
              "title": {
                "type": "string",
                "title": "title"
              },
              "price": {
                "type": "string",
                "title": "price"
              },
              "date": {
                "type": "string",
                "title": "date"
              },
              "id": {
                "type": "number",
                "title": "id"
              },
              "name": {
                "type": "string",
                "title": "name"
              },
              "time": {
                "type": "string",
                "title": "time"
              }
            }
          }
        },
        "sceneCode": {
          "type": "string",
          "title": "sceneCode"
        },
        "url": {
          "type": "string",
          "title": "url"
        },
        "successTip": {
          "type": "string",
          "title": "successTip"
        }
      }
    }
  }
}