JSON Schema
JSON Schema describes the structure and constraints of JSON data. A validator checks these rules; conformance alone does not establish business correctness.
JSON Schema is a language for describing the structure and constraints of JSON data. These include data types and rules for properties. A validator can check whether specific data conforms to the supplied schema.
Distinguish valid JSON from suitable data
In a fictional order intake, the quantity field must contain an integer. The numeric value 2 and the string "2" are different value types. A syntactically valid JSON document therefore does not automatically meet the agreed field rule.
Define required fields explicitly
The JSON Schema documentation explains that listed properties are not automatically required. Required information must be specified accordingly in the schema. The overview describes checking with a validator. Even a passed schema check does not confirm that the quantity belongs to the right order or has been processed in the ERP. Checking the structure, matching to the correct order and confirming successful processing each require suitable evidence.
Sources
Related terms
- Data schemaA data schema describes the structure and rules of data. It defines fields and data types, for example; provenance and freshness are additional questions.
- Interface contractAn interface contract describes the agreed data exchange. Data structure, responses and their meaning need to fit together for both sides.
- Server-sent eventsServer-sent events carry text notifications from server to client over HTTP, for example about the progress of a background job.
- Entity tagAn ETag identifies a particular representation version of an HTTP resource and supports conditional reads or changes.
- Cross-Origin Resource SharingCORS controls browser access to responses across origin boundaries. It replaces neither API login nor permission checks.
- Electronic Data InterchangeEDI transfers structured business documents between systems. Format, partner profile, data mapping and responses need to agree.
Your project with ASES
Describe your project to us. We will get back to you with an initial assessment.