mock-json-data
A easy use mock json data generator npm cli tool for front-end engineer.
Installation
$ npm install -g mock-json-data
Usage
$ mock <schema-file> <output-file-name>
Schema
A schema file defines the structure of data. It is a object array. A simple schema looks like this:
key
and type
is required for every object. key
is the property name of data and type tells how to generate data. Currently, type is one of ['index', 'number', 'exactly', 'enum', 'word', 'sentence', 'date', 'object', 'array']
, each type can have some other property.
Schema Detail
index
: auto increase for index purposestart
: the start index, should be a number, optional, default = 0
number
: generate number datarange
: the range of generate number, array with two number inside, optional, default = [0,10]decimal
: the decimal of number, should be a number, optional, default = 0
exactly
: generate an exactly given valuevalue
: the value need to generate, required
enum
: choose one from given array value randomlyvalue
: the collection of enum, should be an array, required, eg:["Mon","Tue","Wen","Thu","Fri"]
word
: generate some lorem ipsum words, powered by lorem-ipsum.jslength
: the amount of words, should be a number, optional, default = 10
sentence
: generate some lorem ipsum sentence, powered by lorem-ipsum.jslength
: the amount of sentence, should be a number, optional, default = 5
date
: generate date type datarange
the range of generate date, array with two date inside, optional, default = ['1970-0-1',now]format
: format of date, optional , default = 'yyyy/mm/dd', check node-dateformat for more types of format
object
: generate object dataschema
: the sub-schema of object, the rule is same as schema, required
array
: generate array(list,collection) datalength
: the length of array, should be number, requiredschema
: the sub-schema of array, the rule is same as schema, required
Todo Lists
- build-in enum (eg: name, month, address )
- more types support
- GUI