# jsonschema
[<img alt="crates.io" src="https://img.shields.io/crates/v/jsonschema.svg?style=flat-square&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/jsonschema)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-jsonschema-66c2a5?style=flat-square&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/jsonschema)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/Stranger6667/jsonschema-rs/ci.yml?branch=master&style=flat-square" height="20">](https://github.com/Stranger6667/jsonschema-rs/actions?query=branch%3Amaster)
[<img alt="codecov.io" src="https://img.shields.io/codecov/c/gh/Stranger6667/jsonschema-rs?logo=codecov&style=flat-square&token=B1EnafGlRL" height="20">](https://app.codecov.io/github/Stranger6667/jsonschema-rs)
[<img alt="Supported Dialects" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fbowtie.report%2Fbadges%2Frust-jsonschema%2Fsupported_versions.json&style=flat-square">](https://bowtie.report/#/implementations/rust-jsonschema)
A high-performance JSON Schema validator for Rust.
```rust
use serde_json::json;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let schema = json!({"maxLength": 5});
let instance = json!("foo");
// One-off validation
assert!(jsonschema::is_valid(&schema, &instance));
// Build & reuse (faster)
let validator = jsonschema::compile(&schema)
.expect("Invalid schema");
// Iterate over errors
if let Err(errors) = validator.validate(&instance) {
for error in errors {
eprintln!("Error: {}", error);
eprintln!("Location: {}", error.instance_path);
}
}
// Boolean result
assert!(validator.is_valid(&instance));
Ok(())
}
```
You also can use it from the command line via the [jsonschema-cli](crates/jsonschema-cli) crate.
```console
$ jsonschema-cli schema.json -i instance.json
```
See more usage examples in the [documentation](https://docs.rs/jsonschema).
## Highlights
- 📚 Support for popular JSON Schema drafts
- 🔧 Custom keywords and format validators
- 🌐 Remote reference fetching (network/file)
- 🎨 `Basic` output style as per JSON Schema spec
- 🔗 Bindings for [Python](crates/jsonschema-py), [Ruby](https://github.com/driv3r/rusty_json_schema), and [JavaScript](https://github.com/ahungrynoob/jsonschema)
- 💻 Command Line Interface
### Supported drafts
Compliance levels vary across drafts, with newer versions having some unimplemented keywords.
- 
- 
- 
- 
- 
You can check the current status on the [Bowtie Report](https://bowtie.report/#/implementations/rust-jsonschema).
## Notable Users
- Tauri: [Config validation](https://github.com/tauri-apps/tauri/blob/c901d9fdf932bf7c3c77e9d3097fabb1fe0712af/crates/tauri-cli/src/helpers/config.rs#L173)
- Apollo Router: [Config file validation](https://github.com/apollographql/router/blob/855cf6cc0757ca6176970ddf3ae8c98c87c632d1/apollo-router/src/configuration/schema.rs#L120)
- QSV: [CSV record validation with custom keyword & format validator](https://github.com/jqnatividad/qsv/blob/4774cb779c7a5939e10ce32f91ac8447158c276c/src/cmd/validate.rs#L506)
## Performance
`jsonschema`` outperforms other Rust JSON Schema validators in most scenarios:
- Up to **20-470x** faster than `valico` and `jsonschema_valid` for complex schemas
- Generally **2-3x** faster than `boon`
For detailed benchmarks, see our [full performance comparison](crates/benchmark-suite).
## Minimum Supported Rust Version (MSRV)
This crate requires Rust 1.70 or later.
## Support
If you have questions, need help, or want to suggest improvements, please use [GitHub Discussions](https://github.com/Stranger6667/jsonschema-rs/discussions).
## Sponsorship
If you find `jsonschema` useful, please consider [sponsoring its development](https://github.com/sponsors/Stranger6667).
## Contributing
We welcome contributions! Here's how you can help:
- Share your use cases
- Implement missing keywords
- Fix failing test cases from the [JSON Schema test suite](https://bowtie.report/#/implementations/rust-jsonschema)
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License
Licensed under [MIT License](LICENSE).