json-schema-viewer

Welcome to JSON Schema Viewer!

Try it out today at: https://json-schema.app

JSON Schema is awesome. It lets you define and validate the schema for your JSON object and is used to define many many JSON structures. For example schemas, please see: https://www.schemastore.org/json/

However, as great as the format is, without familiarity, it is often very difficult to read JSON Schema and understand exactly what JSON is allowed by the schema. Well, fear not! JSON Schema Viewer to the rescue: just paste a link to your JSON Schema and it will be rendered beautifully, comprehensively and with examples describing the JSON you should expect at evely level of the hierarchy.

Usage

To run this project locally:

Run yarn to install the dependencies.
Run yarn gen-schema to generate source from schema.
In one terminal, run yarn http-serve
In another terminal, run yarn build-dev --watch

Now open: http://localhost:8080 to see the site and develop it live.

Deployment

To publish new SPA website resources to this AWS stack (this is the most common operation you will perform):

nix-shell -p awscli2
yarn build-and-upload

To deploy this project in a way that updates the AWS Configuration via Cloud Formation:

nix-shell -p awscli2
yarn build-and-deploy

Documentation

This project is a React SPA that is designed to be deployed to AWS CloudFront. It implements a Schema Explorer for JSON Schema and does not build an abstraction layer between JSON Schema and the UI layer. We currently support JSON Schema Draft 07 in the code.

Tests

There are currently no tests for this project. Instead, we use and browse the react storybooks to ensure that the schema is being rendered correctly.

Contributions

Contributions to json-schema-viewer are welcome! Please see CONTRIBUTING.md for details.