JSON Schema Architecture: Draft 07 / 2020-12 Contract Specifications
JSON Schema is an IETF standard that provides structural validation, documentation, and interaction control for JSON documents. In modern microservices, JSON Schema acts as the single source of truth for request payload validation, preventing runtime data corruption before inputs reach downstream database layers.
1. Core Validation Directives
- required: Array of property names that must be present on the instance object.
- type: Restricts primitive types (string, number, integer, boolean, array, object, null).
- properties & additionalProperties: Defines per-property validation schemas and restricts unknown keys.
Frequently Asked Questions (FAQ)
What is JSON Schema and why is it used in API engineering?
JSON Schema is an IETF standard that provides contract validation for JSON documents. It enforces data types, required keys, numeric ranges, and regex patterns, serving as the foundation of OpenAPI specifications and automated API contract testing.
Can I automatically infer a JSON Schema from an existing JSON document?
Yes. The studio analyzes the structure, nested types, arrays, and primitive values of any JSON object to automatically generate a compliant JSON Schema specification.
How does the in-browser mock data generator work?
The generator traverses your JSON Schema definitions, inspecting property types and string formats to synthesize realistic dummy JSON objects matching your constraints.