json-schema-it



JSON Schema generator.

Quick Start

``ts
import { generateSchema } from 'json-schema-it';

generateSchema(42); // { type: 'integer' }
`

Installation

NPM:

`sh
npm install json-schema-it
`

Yarn:

`sh
yarn add json-schema-it
`

Usage

ES Modules:

`ts
import { generateSchema } from 'json-schema-it';
`

CommonJS:

`ts
const { generateSchema } = require('json-schema-it');
`

Generate JSON Schema:

`ts
generateSchema({
productId: 1,
productName: 'A green door',
price: 12.5,
tags: ['home', 'green'],
});
`

Output:

`ts
{
type: 'object',
properties: {
productId: { type: 'integer' },
productName: { type: 'string' },
price: { type: 'number' },
tags: { type: 'array', items: { type: 'string' } },
},
}
`

An error will be thrown for an invalid JSON value:

`ts
generateSchema(undefined); // Uncaught TypeError: Invalid JSON value: undefined
``

Release

Release is automated with Release Please.

License

MIT