JSON Schema for the enterprise
The JSONx project provides the JSON Schema Definition Language for JSON, which is a schema language designed in close resemblance to the XMLSchema specification. The schema language extends the capabilities found in JSON documents, by allowing for the description of the structure and to constrain the contents of JSON documents. The schema language is represented in two different but equally translatable vocabularies: a JSON vocabulary, and an XML vocabulary.
This document introduces the JSONx project, and presents a directory of links to its constituent parts and related resources.
1 Introduction
1.1 Conventions Used in This Document
2 Use-Cases
2.1 Consumer Driven Contracts
3 JSON Schema Definition Language
4 JSONx Framework for Java
5 Contributing
6 Special Thanks
7 License
The JSONx project was created to help developers address common problems and use-cases when working with JSON documents. The JSONx project offers structural and functional patterns that systematically reduce errors and pain-points commonly encountered when developing software that interfaces with JSON. The structural patterns are defined in the JSON Schema Definition Language, which is a programming-language-agnostic schema language used to describe constraints and document the meaning, usage and relationships of the constituent parts of JSON documents. The functional patterns are reference implementations of the specification of the schema language, providing utilities that address common use-cases for applications that use JSON in one way or another. Common use-cases include:
- Definition of a normative contract between a producer and consumer of JSON documents.
- Validation of JSON documents conforming to a respective schema document.
- Java class binding API for JSON documents conforming to a respective schema document.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119.
The following sections lists common use-cases where JSONx project can be used.
The JSONx project was created specifically with Consumer Driven Contracts❐ in mind. With the JSON Schema Definition Language (JSD), one can create a Consumer Driven Contract (CDC) with a model that includes the capacity to evolve based on schema versioning. Additionally, the JSD can be used by producers and consumers to validate documents in a communication protocol.
The following example illustrates a simple protocol that uses the CDC approach, and consists of the actors:
- Producer: Representing the provider of the ProductSearch service.
- Consumer1: The first consumer of the ProductSearch service.
- Consumer2: The second consumer of the ProductSearch service.
Consider a simple ProductSearch service, which allows consumer applications to search a product catalogue.
Version v1 of the protocol defines the contract:
-
Request
GET /ProductSearch?name=<name> -
Response
{ "Version": "v1", "CatalogueID": <number>, "Name": <string>, "Price": <string>, "Manufacturer": <string>, "InStock": <boolean> }
The schema that describes the Response contract is:
{
"jx:ns": "http://www.jsonx.org/schema-0.3.jsd",
"jx:schemaLocation": "http://www.jsonx.org/schema-0.3.jsd http://www.jsonx.org/schema.jsd",
"product": { "jx:type": "object", "abstract": true, "properties": {
"CatalogueID": { "jx:type": "number", "range": "[1,]", "scale": 0, "nullable": false},
"Name": { "jx:type": "string", "pattern": "\\S|\\S.*\\S", "nullable": false },
"Price": { "jx:type": "string", "pattern": "\\$\\d+\\.\\d{2}", "nullable": false },
"Manufacturer": { "jx:type": "string", "pattern": "\\S|\\S.*\\S", "nullable": false },
"InStock": { "jx:type": "boolean", "nullable": false} } },
"product1": { "jx:type": "object", "extends": "product", "properties": {
"Version": { "jx:type": "string", "pattern": "v1", "nullable": false } } }
}<schema
xmlns="http://www.jsonx.org/schema-0.3.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.jsonx.org/schema-0.3.xsd http://www.jsonx.org/schema.xsd">
<object name="product" abstract="true">
<property name="CatalogueID" xsi:type="number" range="[1,]" scale="0" nullable="false"/>
<property name="Name" xsi:type="string" pattern="\S|\S.*\S" nullable="false"/>
<property name="Price" xsi:type="string" pattern="\$\d+\.\d{2}" nullable="false"/>
<property name="Manufacturer" xsi:type="string" pattern="\S|\S.*\S" nullable="false"/>
<property name="InStock" xsi:type="boolean" nullable="false"/>
</object>
<object name="product1" extends="product">
<property name="Version" xsi:type="string" pattern="v1" nullable="false"/>
</object>
</schema>Note: The Converter utility automatically converts between JSD and JSDx.
All actors -- Producer, Consumer1, and Consumer2 -- agree on the contract, and implement and integrate the protocol into their systems. To assert receipt of contract-compliant documents, all actors use the contract definition to automatically validate received and sent messages.
After many months of running in production, Consumer2 issues a request to the Producer to provide additional information in the response. Specifically, Consumer2 requests for the addition of another field in the JSON response:
{
- "Version": "v1.0",
+ "Version": "v2.0",
"CatalogueID": <number>,
"Name": <string>,
"Price": <string>,
"Manufacturer": <string>,
"InStock": <boolean>,
+ "Description": <string>
}To satisfy Consumer2's request, the contract is updated to support version v2 of the Response:
{
"jx:ns": "http://www.jsonx.org/schema-0.3.jsd",
"jx:schemaLocation": "http://www.jsonx.org/schema-0.3.jsd http://www.jsonx.org/schema.jsd",
"product": { "jx:type": "object", "abstract": true, "properties": {
"CatalogueID": { "jx:type": "number", "range": "[1,]", "scale": 0, "nullable": false},
"Name": { "jx:type": "string", "pattern": "\\S|\\S.*\\S", "nullable": false },
"Price": { "jx:type": "string", "pattern": "\\$\\d+\\.\\d{2}", "nullable": false },
"Manufacturer": { "jx:type": "string", "pattern": "\\S|\\S.*\\S", "nullable": false },
"InStock": { "jx:type": "boolean", "nullable": false} } },
"product1": { "jx:type": "object", "extends": "product", "properties": {
"Version": { "jx:type": "string", "pattern": "v1", "nullable": false } } }
+ "product2": { "jx:type": "object", "extends": "product", "properties": {
+ "Version": { "jx:type": "string", "pattern": "v2", "nullable": false },
+ "Description": { "jx:type": "string", "pattern": "\\S|\\S.*\\S", "nullable": false } } }
}<schema
xmlns="http://www.jsonx.org/schema-0.3.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.jsonx.org/schema-0.3.xsd http://www.jsonx.org/schema.xsd">
<object name="product" abstract="true">
<property name="CatalogueID" xsi:type="number" range="[1,]" scale="0" nullable="false"/>
<property name="Name" xsi:type="string" pattern="\S|\S.*\S" nullable="false"/>
<property name="Price" xsi:type="string" pattern="\$\d+\.\d{2}" nullable="false"/>
<property name="Manufacturer" xsi:type="string" pattern="\S|\S.*\S" nullable="false"/>
<property name="InStock" xsi:type="boolean" nullable="false"/>
</object>
<object name="product1" extends="product">
<property name="Version" xsi:type="string" pattern="v1" nullable="false"/>
</object>
+ <object name="product2" extends="product">
+ <property name="Version" xsi:type="string" pattern="v2" nullable="false"/>
+ <property name="Description" xsi:type="string" pattern="\S|\S.*\S" nullable="false"/>
+ </object>
</schema>Note: The Converter utility automatically converts between JSD and JSDx.
With this approach, the v2 evolution of the contract satisfies Customer2. And, since the contract also retains support for v1, integration with Customer1 is unaffected.
For the application code, see Sample: Consumer Driven Contracts.
Describes JSON documents using schema components to constrain and document the meaning, usage and relationships of their constituent parts: value types and their content.
For a detailed specification of the schema language, see JSON Schema Definition Language.
Provides a reference implementation of a processor, validator, and binding API for the JSON Schema Definition Language (JSD). The framework also provides a collection of structural and functional patterns intended to help developers work with JSON documents.
For a detailed specification of the JSONx Framework for Java and its modules, see JSONx Framework for Java.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Special thanks to EJ Technologies for providing their award winning Java Profiler (JProfiler) for development of the JSONx Framework.
This project is licensed under the MIT License - see the LICENSE.txt file for details.