I recently used JSON Schema in one of my projects for API request validation on AWS API gateway. I found it overwhelming at first, but quite powerful as it fit our use case quite well. Validating request before it hits your back-end system can filter out quite a lot of bad/invalid requests.
What is JSON Schema?
JSON Schema is a way to describe the structure and validation rules for JSON data. It's a JSON document that defines the expected format, data types, constraints, and rules for the JSON data. JSON Schema can be used to ensure that the JSON data produced by an application or API conforms to a specified format, and to validate the data provided by a client.
How to write one?
To write a JSON Schema, you need to define the properties of the JSON object you want to validate, and the rules for those properties. Here is an example of a simple JSON Schema that defines a person object with two properties, "name" and "age":
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer",
"minimum": 18
}
},
"required": ["name", "age"]
}
In this example, the type property is used to specify the data type of each property. The minimum property is used to specify a minimum value for the "age" property. The required property is used to specify which properties are required.
The "$schema" property at the top of the document specifies the version of the JSON Schema specification being used.
We can validate the schema online at https://www.jsonschemavalidator.net/
Pros & Cons
Pros:
Improved Data Quality: JSON Schema provides a way to validate JSON data against a set of rules, ensuring that it conforms to the expected structure and data types. This can help to improve the overall quality of the data.
Increased Consistency: By enforcing a standardized structure and format for JSON data, JSON Schema can help ensure that data is consistent across different applications and systems.
Better Documentation: JSON Schema provides a clear and concise way to document the structure and constraints of JSON data, making it easier for developers to understand and work with the data.
Widely Supported: JSON Schema is a widely adopted standard, supported by many programming languages and tools, making it easy to use and integrate into existing systems.
Cons:
Complexity: JSON Schema can be complex and difficult to learn, particularly for developers who are new to the concept of data validation.
Performance Overhead: Validating JSON data against a JSON Schema can add additional overhead and processing time, particularly for large datasets.
Limited Expressiveness: While JSON Schema provides a wide range of validation rules and keywords, there are some constraints and data structures that cannot be fully expressed using JSON Schema.
Learning Curve: Learning how to write JSON Schema can be time-consuming, particularly for developers who are not familiar with the JSON Schema syntax and validation rules.
Takeaway
JSON Schema supports a wide range of validation rules and keywords to describe complex data structures and constraints. You can find more information and examples in the JSON Schema documentation: https://json-schema.org/learn/
