Naar de inhoud

JSON Schema

JSON Schema beschrijft structuur en beperkingen van JSON-gegevens. Een validator controleert die regels; voldoen eraan bewijst nog geen zakelijke juistheid.

API's en datacontracten

JSON Schema is een taal om structuur en beperkingen van JSON-gegevens te beschrijven. Daaronder vallen gegevenstypen en regels voor eigenschappen. Een validator kan controleren of concrete gegevens voldoen aan het opgegeven schema.

Onderscheid geldige JSON-syntaxis en passende gegevens

Bij een fictieve orderontvangst moet het veld quantity een geheel getal bevatten. De numerieke waarde 2 en de tekenreeks "2" zijn verschillende waardetypen. Een syntactisch geldig JSON-document voldoet dus niet automatisch aan de afgesproken veldregel.

Leg verplichte velden expliciet vast

De JSON Schema-documentatie legt uit dat opgesomde eigenschappen niet automatisch verplicht zijn. Vereiste informatie moet overeenkomstig in het schema worden vastgelegd. Het overzicht beschrijft controle door een validator. Ook een geslaagde schemacontrole bevestigt niet dat de hoeveelheid bij de juiste order hoort of in het ERP is verwerkt. Structuurcontrole, koppeling aan de juiste order en succesvolle verwerking vragen elk passend bewijs.

Bronnen