Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Generate static HTML documentation from JSON schemas

Project description

JSON Schema for Humans

Quickly generate a beautiful HTML static page documenting a JSON schema

Documentation

Installation

pip install json-schema-for-humans

Usage

generate-schema-doc [OPTIONS] SCHEMA_FILE [RESULT_FILE]

SCHEMA_FILE must be a valid JSON Schema

A CSS file will be copied in the same directory as RESULT_FILE

The default value for RESULT_FILE is schema_doc.html

Options

--minify/--no-minify

On by default

Minify the output HTML document

--deprecated-from-description

Off by default

Mark a property as deprecated (with a big red badge) if the description contains the string [Deprecated

--default-from-description

Off by default

Extract the default value of a property from the description like this: [Default `the_default_value`]

The default value from the "default" attribute will be used in priority

What's supported

See the excellent Understanding JSON Schema to understand what are those checks

The following are supported:

  • Types
  • Regular expressions
  • Numeric types multiples and range
  • Constant and enumerated values
  • Required properties
  • Default values
  • Array minItems, maxItems, uniqueItems, items (schema that must apply to all of the array items), and contains
  • Combining schema with oneOf, allOf, anyOf, and not

These are not supported at the moment (PRs welcome!):

  • String length and format
  • Property names, size, and pattern
  • Array items at specific index (for example, first item must be a string and second must be an integer)
  • Property dependencies
  • Examples
  • Media
  • Conditional subschemas

References from inside a schema are supported (for example { $ref: "#/definitions/something" } will be replaced by the content of schema["definitions"]["something"])

References to schemas in other files are not supported for now.

Development

Testing

Just run tox

tox

Generating doc

The documentation is generated using jekyll and hosted on GitHub Pages

  • Change your current working directory to docs
  • Run python generate_examples.py. This will get all examples from tests/cases, render the resulting HTML and include it in the appropriate folders in the jekyll site.
  • If you have added an example, add the file name (without .json), the display name and description in _data/examples.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for json-schema-for-humans, version 0.2.4
Filename, size File type Python version Upload date Hashes
Filename, size json_schema_for_humans-0.2.4-py3-none-any.whl (11.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size json-schema-for-humans-0.2.4.tar.gz (20.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page