README.md

jsonschematic

jsonschematic is a json schema in the same vein as docson.

The interactive(!) demo page lives at https://yanick.github.io/jsonschematic/.

How to run

From a global install:

$ npm install -g @infinity-interactive/jsonschematic
$ jsonschematic --schema_dir path/to/schemas

From the repo:

$ git clone https://github.com/yanick/jsonschematic.git
$ cd jsonschematic
$ npm install
$ JSONSCHEMATIC_DIR=examples npm run dev

Supported JSON Schema keywords

• $comment

• $id

• $ref

• $schema

• title

• type

  • integer

  • number

    • minimum
    • maximum
    • exclusiveMaximum
    • exclusiveMinimum
    • multipleOf

  • string

    • minLength
    • maxLength
    • format
    • contentEncoding
    • contentMediaType

  • array

    • minItems
    • maxItems
    • minContains
    • maxContains
    • uniqueItems
    • items
      • as a schema
      • as a tuple
    • additionalItems

  • boolean

  • enum

  • const

  • null

  • object

    • properties
    • required
    • maxProperties
    • minProperties
    • propertyNames
    • additionalProperties
      • as boolean
      • as object
    • patternProperties

  • type as an array of types

• dependencies

  • property dependencies
  • schema dependencies

• if

  • then
  • else

• allOf

• anyOf

• oneOf

• not

• readOnly

• writeOnly

• contains

• definitions

• default

• examples

  • scalar values
  • data structures issue #66

• pattern

• schema as a boolean

Authors

jsonschematic is developed under the auspice of Infinity Interactive.

© 2020 Infinity Interactive