jsonschema 0.10.0

A crate for performing JSON schema validation
Documentation

jsonschema

A crate for performing fast JSON Schema validation. It is fast due to schema compilation into a validation tree, which reduces runtime costs for working with schema parameters.

Supports:

  • JSON Schema drafts 4, 6, 7 (except some optional test cases);
  • Loading remote documents via HTTP(S);

Usage Examples:

A schema can be compiled with two main flavours:

  • using default configurations
# use jsonschema::{Draft, JSONSchema};
# use serde_json::json;
# fn foo() {
# let schema = json!({"maxLength": 5});
let compiled_schema = JSONSchema::compile(&schema).expect("A valid schema");
# }
  • using custom configurations (such as define a Draft version)
# use jsonschema::{Draft, JSONSchema};
# use serde_json::json;
# fn foo() {
# let schema = json!({"maxLength": 5});
let compiled_schema = JSONSchema::options()
.with_draft(Draft::Draft7)
.compile(&schema)
.expect("A valid schema");
# }

Example (CLI tool to highlight print errors)

use jsonschema::{Draft, JSONSchema};
use serde_json::json;

let schema = json!({"maxLength": 5});
let instance = json!("foo");
let compiled = JSONSchema::options()
.with_draft(Draft::Draft7)
.compile(&schema)
.expect("A valid schema");
let result = compiled.validate(&instance);
if let Err(errors) = result {
for error in errors {
println!("Validation error: {}", error);
println!("Instance path: {}", error.instance_path);
}
}

Each error has an instance_path attribute that indicates the path to the erroneous part within the validated instance. It could be transformed to JSON Pointer via .to_string() or to Vec<String> via .into_vec().