Generate static HTML documentation from JSON schemas
Project description
JSON Schema for Humans
Quickly generate a beautiful HTML static page documenting a JSON schema
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
--expand-buttons
Off by default
Add an Expand all
and a Collapse all
button at the top of the generated documentation
--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), andcontains
- Combining schema with
oneOf
,allOf
,anyOf
, andnot
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 and to schemas in other files are supported (for example { $ref: "#/definitions/something" }
will be replaced by the
content of schema["definitions"]["something"]
).
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 fromtests/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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for json-schema-for-humans-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 310fff1b263111dbe8ecfb829960f556904d8c5350a4322bb299a8fa9dd5d0ab |
|
MD5 | 3069988dd2ff16c36fba4c20f04506f9 |
|
BLAKE2b-256 | 69986f3ef7da8f88148e770633a8b2f5cdda6a1d5170dbdf2861691713771315 |
Hashes for json_schema_for_humans-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 572f0b68e3f547e9d63586cab848b93c08d8d6a37898fc40ffe4b8842b214739 |
|
MD5 | a599d5d0cb3f5839cbf7dc22cf78364a |
|
BLAKE2b-256 | c74b9e34a6081ef23b21251d826b672c6256293c60258fa77c65051cc403c7aa |