go-jsonschema-playground

README

go-jsonschema-playground

Usage

Generate json schema

Run go run . generate-json-schema, this will create docs/schema.json

Generate markdown doc

1. (Run only once) Install json-schema-for-humans, requires pip: pip install json-schema-for-humans
2. Run generate-schema-doc --config template_name=md docs/schema.json docs/config-file.md, this will create docs/config-file.md

Generate HTML doc

1. (Run only once) Install json-schema-for-humans, requires pip: pip install json-schema-for-humans. NOTE: this is the same tool as in previous step, so if you've already isntalled it, no need to do it again
2. Run generate-schema-doc docs/schema.json docs/config-file.html, this will create docs/config-file.html, docs/schema_doc.html, docs/schema_doc.html

Tools and resources arround json schema

• Used to generate schema from Go code
• Used to generate web UI doc
• Official list of tools