JSON Schema Documentation Generators

Question

I have looked all over google for hours trying to find a good JSON Schema documentation generator, but I can't seem to find any good ones. Every one listed on http://json-schema.org/implementations has some problem. For Matic, I don't like the look (Actually having brackets, and showing $schema), for Doca, it doesn't work on windows, and for Docson, it can't handle infinite loops. Basically, I want a JSON Schema documentation generator that can

Handle infinite reference loops in a good way
Can work on windows
Has an output that doesn't show the output like Matic, but more like Docson.
Has a static output, so the user doesn't have to click anything

score 3 · Accepted Answer · answered Oct 15 '17 at 11:08

3

I found a hit that works very well. https://github.com/bootprint/bootprint-json-schema is a node module that has the perfect system.

answered Oct 15 '17 at 11:08

1

Unfortunately it doesn't support `patternProperties` at the moment. – Chris Hunt Sep 29 '18 at 19:19
It also doesn't seem to support multiple input files (e.g. if you `$ref` other schemas)... – Jason C Jun 29 '22 at 23:23

score 3 · Answer 2 · answered Aug 17 '19 at 11:44

3

https://github.com/adobe/jsonschema2md - As it's name suggests, generated Markdown from JSON Schema files.

answered Aug 17 '19 at 11:44

Ramon

401
6
8

score 1 · Answer 3 · answered Oct 19 '17 at 21:15

1

There is also PRMD, although I think it has similar limitations: https://github.com/interagent/prmd

Hopefully with JSON Hyper-Schema draft-07 about to be published, there will be a new generation of API documentation systems to follow.

answered Oct 19 '17 at 21:15

Henry Andrews

663
3
6

JSON Schema Documentation Generators

3 Answers3