schematized

Schematized

Turn JS objects into JSON schemas that continue to improve as you provide examples.

A Node port of the Python module Genson.

:rocket: Quickstart

1. Add dependency

yarn add schematized

1. Basic usage

import { SchemaBuilder } from 'schematized' // Typescript & ES6+
const { default: SchemaBuilder } = require('schematized') // CommonJS

const builder = new SchemaBuilder()

// Consume JSON
builder.addObject({
  token: '74aea1a53d68b77e4f1f55fa90a7eb81',
  role: ['Basic'],
})

// Produce JSON Schemas!
const schema = builder.toSchema()

1. Improve the schema

...

// Add more example objects
builder.addObject({
  token: 'Bearer 6498d9afc96d1d8d881a2b7ded4f9290',
  role: [
    'Admin',
    'Basic',
    'Publisher'
  ]
})

// Or combine data from another JSON Schema
builder.addSchema(savedSchema)

Schema from the single example:

Schema from the two examples:

Schema from the two examples and the previously saved schema:

Changelog

1.3.0 (2020-06-21)

Features

• removed duplicate step in ci: removed Build step in CI since Test step already does a build (90712ed)