Convert JSON Schema to human-readable Markdown documentation
Project description
jsonschema2md
Convert JSON Schemas to simple, human-readable Markdown documentation.
For example:
{
"$id": "https://example.com/person.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Person",
"description": "JSON Schema for a person object.",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The person's first name."
},
"lastName": {
"type": "string",
"description": "The person's last name."
}
}
}
will be converted to:
Person
JSON Schema for a person object.
Properties
firstName
(string): The person's first name.lastName
(string): The person's last name.
See the examples directory for more elaborate examples.
Installation
Install with pip
$ pip install jsonschema2md
Usage
From the CLI
$ jsonschema2md <input.json> <output.md>
From Python
import jsonschema2md
parser = jsonschema2md.Parser()
md_lines = parser.parse_schema(json.load(input_json))
Contributing
Bugs, questions or suggestions? Feel free to post an issue in the issue tracker or to make a pull request! See Contributing.md for more info.
Changelog
See Changelog.md.
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
jsonschema2md-0.2.1.tar.gz
(8.2 kB
view hashes)
Built Distribution
Close
Hashes for jsonschema2md-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e52eaa023450769d45a09c1c3f434923e95ad8139071f31f76c565b86f5a6f1b |
|
MD5 | 78379b7a805fd479f440e8621c85e1e0 |
|
BLAKE2b-256 | 8ca42ad6cd906b1dc8b16c870a2de388725c30fc0ccf5e9f6b1cb0c8c6d59698 |