Ako použiť JSON Schema na validáciu vašich dát
Čo je to JSON Schema?
JSON Schema je štandardizovaný spôsob, ako popísať štruktúru, povinné polia a typy hodnôt vo vašich JSON dátach. Môžete si to predstaviť ako zmluvu alebo plán, ako by mal vyzerať platný JSON. JSON Schema je napísané priamo v JSON, vďaka čomu je strojovo čitateľné a ľahko upraviteľné.
Prečo validovať pomocou schémy?
- Prevenovať chyby zachytením neplatných alebo chýbajúcich dát ešte predtým, než spôsobia problémy.
- Zabezpečiť konzistenciu dát medzi rôznymi tímami, aplikáciami alebo API.
- Automaticky generovať dokumentáciu zo schém.
- Pomôcť editorom a nástrojom poskytovať lepšie automatické dopĺňanie a pomoc priamo v riadku.
Jednoduchý príklad: Základná schéma
Tu je základný JSON objekt nasledovaný minimálnou schémou, ktorá overuje jeho štruktúru:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Táto schéma zabezpečuje, že objekt musí obsahovať 'name' (ako reťazec) a 'age' (ako číslo).
Ako napísať vlastnú schému
V schéme môžete definovať pokročilé pravidlá: obmedziť hodnoty polí, definovať vnorené objekty alebo nastaviť minimálne/maximálne čísla. Tu je príklad overujúci pole produktov:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Použitie JSONValidator.dev na validáciu schém
- Vložte svoje JSON dáta do hlavného editora.
- Vložte svoju JSON schému do políčka editora schém nižšie.
- Kliknite na Overiť JSON podľa tejto schémy.
- Skontrolujte výsledky validácie, kde sú chyby zvýraznené a vysvetlené.
Riešenie problémov s chybami validácie
Bežné dôvody chýb validácie zahŕňajú:
- V dátach chýba povinné pole.
- Typ hodnoty nezodpovedá schéme (napr. reťazec vs. číslo).
- Schéma sama o sebe je nesprávna alebo obsahuje preklepy.
Záver
Validácia pomocou JSON Schema je mocným nástrojom na to, aby vaše dáta boli robustné a bez chýb. Vyskúšajte si vytvoriť vlastnú schému s našim bezplatným generátorom JSON schém a validujte ju online naživo!