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.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jsonschema2md-0.1.1.tar.gz.
File metadata
- Download URL: jsonschema2md-0.1.1.tar.gz
- Upload date:
- Size: 7.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.0.10 CPython/3.8.5 Linux/5.3.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a13dfaac916255c919916418e318ebd1949f191205fdfcc074b660ee53af17e
|
|
| MD5 |
ff646a631a8f79fb5612598d0ec9e95c
|
|
| BLAKE2b-256 |
96fc3da23fa89606ba47a1e1d347ec11f8b55c303237239de9ce9b5b8fd7b710
|
File details
Details for the file jsonschema2md-0.1.1-py3-none-any.whl.
File metadata
- Download URL: jsonschema2md-0.1.1-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.0.10 CPython/3.8.5 Linux/5.3.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2016917d3031a9e5be4d12266888de69e890cecb586a467ee0302eb7be570de6
|
|
| MD5 |
2a0c1b27a9bb575d1b732070bc6342f1
|
|
| BLAKE2b-256 |
98861d5731e7bd0966cf6d0b087696dec0bee8bc2fd56dd5fdb636e9dd953ec8
|
