Pick a JSON Schema Visualizer and auto update website with schema and visualizer
tgadam opened this issue · comments
Pick and implement a JSON Schema Visualizer, JSON Schema Documenter and auto update website with schema, documenation, and visualizer.
We want to auto generate the following on post on the fsml website from the https://github.com/TeselaGen/fsml.org/blob/main/packages/standard/fsml-schema.json file.
- Formatted Raw JSON Schema
- Markdown documentation such as https://github.com/CesiumGS/wetzel or https://github.com/atlassian-labs/json-schema-viewer
- Interactive Visualizer such as https://navneethg.github.io/jsonschemaviewer/
@tgadam to pair with @christopher-lamkin on this one asap.
The wetzel one would not run. Looks like it might be windows only? I tried https://www.npmjs.com/package/material-ui-json-schema-viewer for a first pass. Seems like we can use react components pretty easily.
Here's a very good one, not sure if one could automate visualizations:
https://jsonvisio.com
@juanneilson ..looks good.
@tgreen7 : could you use this tool to embed the graph on the fsml website?
Pasting in our example schema it is too big for creating a link. Maybe it will be possible once we actually make our real schema which should be smaller.
not sure about what is it that you are testing, but what about using an URL shortener? (e.g.: https://tinyurl.com/ub2bn4th)
We liked the original schema viewer (https://jsoncrack.com, formerly jsonvisio), but it has some limitations in terms of the size of the schema that can be embedded, using their embedding link (with default parameters). The plan is to download the tool and run it in our own instance, and explore using an embeddable component for a standalone react app.
Next step is to do a simple custom component for docusource, that can be used within fsml.org.
we want this to be solved AykutSarac/jsoncrack.com#149 then we could host our schema on a cdn and easily be able to open it. I think that is preferable to hosting our own docker instance.