Simple utility to mock example objects based on JSON schema definitions
npm install mock-json-schemaSimple utility to mock example objects based on JSON schema definitions
- [x] Minimal & deterministic. Predictable single example with no randomisation involved
- [x] Thoroughly tested feature set
- [x] Supports example, default
- [x] Supports anyOf, allOf, oneOf
- [x] Built-in examples for following string formats:
- email
- hostname
- ipv4
- ipv6
- uri
- uri-reference
- uri-template
- json-pointer
- date-time
- uuid
- [x] TypeScript types included
- [ ] Supports $ref pointers
``javascript
const { mock } = require('mock-json-schema');
const assert = require('assert');
const schema = {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'integer',
minimum: 1,
},
name: {
type: 'string',
example: 'John Doe',
},
email: {
type: 'string',
format: 'email',
},
},
},
};
assert.deepEqual(mock(schema), [{ id: 1, name: 'John Doe', email: 'user@example.com' }]);
``
View more examples
mock-json-schema is Free and Open Source Software. Issues and pull requests are more than welcome!