json-schema-by-example

Generate a JSON schema from an example object

Writing JSON schemata manually is tedious, especially for simple cases. This module enables you to provide an example object and have a matching JSON schema generated for you automatically.

I use it in conjunction with jsonschema for validating 3rd party API responses.

Sorry, not interested in supporting Node.JS older than 6.0.

Example

const schemaByExample = require('json-schema-by-example');

const example = [{
    id: 1,
    owner: {
      login: 'japsu',
    },
    name: 'json-schema-by-example',
}];

const schema = schemaByExample(example);

See also test.js.

License

The MIT License (MIT) Copyright ©️ 2016 Santtu Pajukanta

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.