Packages
Package	Description
org.eel.kitchen.jsonschema.bundle	Schema keywords and keyword bundles
org.eel.kitchen.jsonschema.format	Format specifier classes
org.eel.kitchen.jsonschema.keyword	Schema validation core elements: keyword validators
org.eel.kitchen.jsonschema.main	Main schema validation API
org.eel.kitchen.jsonschema.ref	JSON Reference related packages
org.eel.kitchen.jsonschema.syntax	Schema syntax validation package
org.eel.kitchen.jsonschema.uri
org.eel.kitchen.jsonschema.util	JSON document downloaders
org.eel.kitchen.jsonschema.validator	Core validation process

A JSON Schema validator implementation in Java which aims for correctness and performance, in that order

Why

This implementation is meant to be purely server-side if Java is your language of choice. You may, or may not, use it in your Java Web application, the library has no dependencies at all on anything Web-related.

The two main characteristics of this library are its correctness with regards to the schema specification, and its raw speed. Correctness in that, for instance, it uses ECMA 262 for regexes and can validate numeric instances of arbitrary length and/or precision. No other existing JSON Schema implementation can do both of the latter points, and I can pretty much guarantee that no other library is faster than this one. If you find a counter example, I'd be glad to hear of it!

Sample usage

Create a `JsonSchemaFactory`

You cannot instantiate one directly, you have to go through its included Builder class for that. This is by design: it allows to freeze the schema generation context. Sample code:

    final JsonSchemaFactory.Builder builder = new JsonSchemaFactory.Builder();

    // You can customize the context, see below

    final JsonSchemaFactory schemaFactory = builder.build();

    // Shortcut to create a factory with the default settings:

    final JsonSchemaFactory schemaFactory
        = new JsonSchemaFactory.Builder().build();

You can customize your factory, albeit only in a limited way currently. See JsonSchemaFactory for details.

Register/create a schema

The class for this is JsonSchema. This is a three step process.

First of all, you need to grab your JSON Schema as a JsonNode. For this, you may want to have a look at the JsonLoader class. Then, you need to register this schema. This will create a SchemaContainer object. Finally, create a schema out of this container.

The sample code below shows how to create a validating schema out of the current v3 schema draft, bundled in this library (NOTE: IOException not accounted for):

    final JsonNode rawSchema = JsonLoader.fromResource("/schema-draftv3.json");

    final SchemaContainer container = factory.registerSchema(rawSchema);

    final JsonSchema schema = factory.createSchema(container);

Validate your data

Currently, you must load the data to be validated as a JsonNode. Here again, the JsonLoader class may help you.

One JsonSchema instance may validate as many JSON documents as you want, in parallel: this class is inherently thread safe. Sample code:

    // Here, instance is the data to validate

    final ValidationReport report = schema.validate(instance);

    // Validation is a success if the report is empty: test it as follows

    System.out.printf("Validation %s\n", report.isSuccess() ? "succeeded"
        : "failed");

json-schema-validator 0.5.0beta4 API

Why

Sample usage

Create a JsonSchemaFactory

Register/create a schema

Validate your data

Create a `JsonSchemaFactory`