Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atlassian-labs/json-schema-viewer
A JSON Schema Viewer for any JSON Schema on earth.
https://github.com/atlassian-labs/json-schema-viewer
documentation json json-schema react validation
Last synced: 23 days ago
JSON representation
A JSON Schema Viewer for any JSON Schema on earth.
- Host: GitHub
- URL: https://github.com/atlassian-labs/json-schema-viewer
- Owner: atlassian-labs
- License: apache-2.0
- Created: 2021-01-20T07:46:30.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T10:39:40.000Z (9 months ago)
- Last Synced: 2024-12-15T21:12:04.581Z (27 days ago)
- Topics: documentation, json, json-schema, react, validation
- Language: TypeScript
- Homepage: https://json-schema.app/
- Size: 662 KB
- Stars: 137
- Watchers: 8
- Forks: 29
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - atlassian-labs/json-schema-viewer - A JSON Schema Viewer for any JSON Schema on earth. (TypeScript)
README
# json-schema-viewer
[](LICENSE) [](CONTRIBUTING.md)
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:
1. Run `yarn` to install the dependencies.
1. (Optional, automatically runs on install) Run `yarn gen-schema` to generate source from schema.
1. Run `yarn start` to start Webpack Dev server
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):
``` shell
nix-shell -p awscli2
yarn build-and-upload
```
To deploy this project in a way that updates the AWS Configuration via Cloud Formation:
``` shell
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](CONTRIBUTING.md) for details.
## License
Copyright (c) 2021 Atlassian and others.
Apache 2.0 licensed, see [LICENSE](LICENSE) file.
[](https://www.atlassian.com)