Load a JSON Schema

Put in the url to the JSON schema that you want to see documented here.

Developing a JSON Schema

If you are busy writing or generating a JSON Schema and you want to get a live experience of viewing that schema using JSON Schema Viewer then you have a few options.

Using a locally running server

JSON Schema Viewer will work so long as your JSON Schema is accessible via a HTTP Get request from your web browser. This means that you can just host the file on your own machine and edit it from there. For example:

  1. In a terminal, go to the directory on your local filesystem that contains your JSON Schema.
  2. In that directory on your local machine, type in:
    Copy
    1 npx http-server -p 9876 --cors -c-1
  3. Navigate to http://localhost:9876/ and click on your JSON Schema link.
  4. Copy the URL for the JSON Schema and paste it into the input above.

And there you have it! You can now view your JSON Schema here. Using this method, you can also live edit the file on your local computer and then you can merely refresh JSON Schema Viewer in your browser and your new content will appear live.

Using Bitbucket Snippets

To use Bitbucket Snippets:

  1. Navigate to: https://bitbucket.org/snippets/new
  2. Paste your JSON Schema into the file text input and fill in the other fields.
  3. Select "Permissions" => "Public" and Create Snippet.
  4. Once the snippet has been created, click on the "Raw" button and copy the raw link to your file.
  5. Paste that link into the input on this page.

And there you have it! You can now view your JSON Schema here. If you wish to update it, merely go back to your gist, update the contents, re-copy the raw url (because it will have updated) and load it into JSON Schema viewer again.

Using Github Gists

To use Github Gists:

  1. Navigate to: https://gist.github.com/
  2. Paste your JSON Schema into the file text input and fill in the other fields.
  3. Select "Create public gist" so that the gist can be viewed by anybody.
  4. Once the gist has been created, click on the "Raw" button and copy the raw link to your file.
  5. Paste that link into the input on this page.

And there you have it! You can now view your JSON Schema here. If you wish to update it, merely go back to your gist, update the contents, re-copy the raw url (because it will have updated) and load it into JSON Schema viewer again.