A curious way to document JSON
A Java library that ingests JSON and spits it back out with HTML-hyperlinked keys. What are the keys hyperlinked to? You decide.
An application I've been writing consists of multiple JSON configuration files. This application also has a web interface. The web interface displays the JSON configuration files sometimes, and I wanted inline documentation on those pages. Specifically, I wanted tooltip hovers for the JSON keys (or names) that would display documentation about each configuration value.
Here's an example:
{
"name":"mild",
"upshift": {
"first": 4000,
"second": 3000,
"third": 3000
},
"downshift": {
"second": 2000,
"third": 1800,
}
}
That's great, but what's it mean? This is what it means (roll-over the hyperlinks):
{
"name":"mild",
"upshift": {
"first": 4000,
"second": 3000,
"third": 3000
},
"downshift": {
"second": 1200,
"third": 1800,
}
}