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
Options
--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 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 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.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa3cad958a3a6270443640c525f9ef2f4b57daac49cd2d4f0d702af50ae2c54f |
|
MD5 | 80624864198c58e4eda4dd9612a99532 |
|
BLAKE2b-256 | b635aefc8cd73102fab2c01e4722f08000ec24d91e249f086a2c857fa8de1ad6 |
Hashes for json_schema_for_humans-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4c18d4f1a39f693fd86f0a1d6bd6d19ddb8d9ce3570b0c2abadef76051d3700 |
|
MD5 | 7aae719d78cf0c6e9f582595dcb20a55 |
|
BLAKE2b-256 | c47b82b78ced5c499b9dd4928a7eb595eae96b4e58168ac1b7fb4312c00c72dd |