JSON Schema Documentation Generators
Solution 1
https://github.com/adobe/jsonschema2md - As it's name suggests, generated Markdown from JSON Schema files.
Solution 2
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.
Related videos on Youtube
Heretic Monkey
Updated on September 15, 2022Comments
-
Heretic Monkey over 1 year
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