Skip to main content

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


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.0.post1.tar.gz (8.1 kB view hashes)

Uploaded Source

Built Distribution

jsonschema2md-0.2.0.post1-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page