JSON Schema Fix

JSON creation, validation, fix and documentation according schema.

If only validation is important to you, we suggest ajv.

Table of Contents

• Installation
• Schema Definition
• Usage
  • Create JSON from schema
  • Validate JSON according schema
  • Fix JSON according schema
  • Create Markdown documentation from schema

Installation

npm install --save json-schema-fix

Schema Definition

The schema has to be defined according https://json-schema.org/.

Accepted/used properties are type, properties, default and description.

Usage

Create JSON from schema

const json = require('json-schema-fix');

const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string',
      default: 'Name',
    },
    age: {
      type: 'number',
      default: '123',
    },
  },
};

const data = json.create(schema);

data:

{
  name: 'Name',
  age: 123
}

Validate JSON according schema

const json = require('json-schema-fix');

const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string',
      default: 'Name',
    },
    age: {
      type: 'number',
      default: '123',
    },
  },
};

const isValid = json.validate(schema, { name: 'Mr Nice Guy', age: 30 });
const isNotValid1 = json.validate(schema, 'any wrong data');
const isNotValid2 = json.validate(schema, { name: 'Mr Nice Guy', age: 'any wrong data' });

isValid:

null

isNotValid1:

[
  {
    error: 'Should be an "object".',
    path: 'root'
  }
]

isNotValid2:

[
  {
    error: 'Should be a "number".',
    path: 'root.age'
  }
]

Fix JSON according schema

const json = require('json-schema-fix');

const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string',
      default: 'Name',
    },
    age: {
      type: 'number',
      default: '123',
    },
  },
};

const fixedData1 = json.fix(schema, undefined);
const fixedData2 = json.fix(schema, { name: 'Mr Nice Guy' });
const fixedData3 = json.fix(schema, { unrelevant: undefined });

fixedData1:

{
  name: 'Name',
  age: '123'
}

fixedData2:

{
  name: 'Mr Nice Guy',
  age: '123'
}

fixedData3:

{
  name: 'Name',
  age: '123'
}

Create Markdown documentation from schema

const json = require('json-schema-fix');

const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string',
      default: 'Name',
      description: 'Name of the person.'
    },
    age: {
      type: 'number',
      default: '123',
      description: 'Age of the person.'
    },
  },
};

const markdownDocumentation = json.docu(schema);

markdownDocumentation:

| Property | Type | Default Value | Description |
|:--- |:--- |:--- |:--- |
| root | *object* | | |
| root.name | *string* | `Name` | Name of the person. |
| root.age | *number* | `123` | Age of the person. |

Rendered:

| Property | Type | Default Value | Description | |:--- |:--- |:--- |:--- | | root | object | | | | root.name | string | Name | Name of the person. | | root.age | number | 123 | Age of the person. |