https://github.com/e0ipso/ajv-inspector

Uses ajv to compile a JSON Schema and lets you inspect it.
https://github.com/e0ipso/ajv-inspector

Last synced: 2 months ago
JSON representation

Uses ajv to compile a JSON Schema and lets you inspect it.

• Host: GitHub
• URL: https://github.com/e0ipso/ajv-inspector
• Owner: e0ipso
• Created: 2016-03-24T18:40:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-11-02T12:40:40.000Z (about 5 years ago)
• Last Synced: 2024-10-12T02:26:34.640Z (3 months ago)
• Language: JavaScript
• Size: 41 KB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/e0ipso/ajv-inspector.svg?branch=master)](https://travis-ci.org/e0ipso/ajv-inspector)

[![Coverage Status](https://coveralls.io/repos/github/e0ipso/ajv-inspector/badge.svg?branch=master)](https://coveralls.io/github/e0ipso/ajv-inspector?branch=master)

This module allows you to inspect a JSON schema. Take a schema and request a path to drill donw into the schema to get the dereferenced schema.

This project is based on [ajv](https://github.com/epoberezkin/ajv) and leverages it to load and compile the JSON schemas.

You don't really need this if you are not using references in your schema.

## API

The first part is loading and compiling the schema, and *then* inspect the schema.

```js

const SchemaInspector = require('ajv-inspector');

const schemaObject = {

  '$schema': 'http://json-schema.org/draft-04/schema#',

  type: 'object',

  title: 'Person',

  requiredProperties: ['location'],

  properties: {

    location: {'$ref': 'http://json-schema.org/geo'},

    address: {'$ref': 'http://json-schema.org/address'},

    name: {

      description: 'The person name',

      type: 'string'

    }

  }

};

// Options are passed to ajv. In this case since we have to load

// data over HTTP we can use the loader helper.

const options = {loadSchema: SchemaInspector.httpSchemaLoader};

// Build the inspector with the schema.

const inspector = new SchemaInspector(schemaObject, options);

// Compile the schema.

inspector.compile()

  .then(() => {

    // You can now inspect the schema!

    console.log(inspector.inspect('location.latitude'));

    // Outputs: {type: 'number'}

  });

```

See the [unit tests](https://github.com/e0ipso/ajv-inspector/blob/master/test/index.js#L111-L130) for more details and examples.