JSON Schema documentation generator

7,598 views
Skip to first unread message

Vivek Vinayagam

unread,
Jul 25, 2014, 8:33:47 PM7/25/14
to json-...@googlegroups.com
Hi,

Is there a tool available that can convert a JSON schema into a HTML/PDF document? I have some REST APIs that are expressed in JSON Schema and I would like to see if I can have a HTML/PDF document of the same.

Thanks!

Justin Halsall

unread,
Jul 28, 2014, 7:41:18 AM7/28/14
to json-...@googlegroups.com
Hi Vivek,

I use PRMD to generate beautiful docs from JSON (Hyper) Schema.
These docs are generated in markdown and then I use Assemble to convert markdown to HTML.

URLs:

Cheers,
Justin Halsall

Vivek Vinayagam

unread,
Jul 28, 2014, 1:43:22 PM7/28/14
to json-...@googlegroups.com
Thanks Justin!

-Vivek

Matthew O'Donoghue

unread,
Aug 11, 2014, 1:36:01 PM8/11/14
to json-...@googlegroups.com
Hi. I just announced an update to Matic which now has vastly improved draft4 support and may support your needs.

https://www.npmjs.org/package/matic

xmlbuddy

unread,
Jul 29, 2014, 4:28:34 AM7/29/14
to json-...@googlegroups.com
Hi Vivek,

on Windows you can use XML ValidatorBuddy (available at http://www.xml-buddy.com - I'm the author of the tool) to generate HTML documentation from your JSON Schema. There is also a public stylesheet (XSL) already available at https://github.com/Clemens-U/JSONSchemaDocStylesheet to generate HTML from JSON Schema (the basic approach is to take an XML conversion of the JSON and to apply a stylesheet).

Simply assign the stylesheet to your JSON Schema within the tool and start the XSL transformation. Of course you can modify the stylesheet to fit your needs.

Regards
Clemens
Reply all
Reply to author
Forward
0 new messages