Jak používat JSON Schema k validaci vašich dat

Co je JSON Schema?

JSON Schema je standardizovaný způsob, jak popsat strukturu, povinná pole a typy hodnot ve vašich JSON datech. Představte si to jako smlouvu nebo plán, jak by měla platná JSON data vypadat. JSON Schema je napsáno samotným JSON, což ho činí snadno čitelným stroji i přehledným pro úpravy.

Proč validovat pomocí schématu?

• Předejděte chybám tím, že zachytíte neplatná nebo chybějící data dříve, než způsobí problémy.
• Zajistěte konzistenci dat napříč týmy, aplikacemi nebo API.
• Automaticky generujte dokumentaci ze schémat.
• Pomozte editorům a nástrojům poskytovat lepší automatické doplňování a nápovědu přímo v kódu.

Jednoduchý příklad: základní schéma

Zde je základní JSON objekt, následovaný minimálním schématem, které ověřuje jeho strukturu:

{
  "name": "Alice",
  "age": 30
}

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "number" }
  },
  "required": ["name", "age"]
}

Toto schéma zaručuje, že objekt musí mít pole 'name' typu string a 'age' typu číslo.

Jak napsat vlastní schéma

Ve schématu můžete definovat pokročilé pravidla: omezit hodnoty polí, definovat vnořené objekty nebo nastavit minimální/ maximální čísla. Zde je příklad, který ověřuje pole s produkty:

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": { "type": "string" },
      "price": { "type": "number", "minimum": 0 },
      "tags": {
        "type": "array",
        "items": { "type": "string" }
      }
    },
    "required": ["id", "price"]
  }
}

Použití JSONValidator.dev pro validaci schémat

1. Vložte svá JSON data do hlavního editoru.
2. Vložte své JSON Schema do editoru pro schémata níže.
3. Klikněte na Validovat JSON proti tomuto schématu.
4. Prohlédněte si výsledky validace s vyznačenými a vysvětlenými chybami.

Řešení chyb validace schématu

Nejčastější příčiny chyb validace jsou:

• V datech chybí povinné pole.
• Typ hodnoty neodpovídá schématu (např. string místo čísla).
• Schéma samotné je neplatné nebo obsahuje překlepy.

Závěr

Validace pomocí JSON Schema je mocný nástroj, jak zajistit robustnost a bezchybnost vašich dat. Vyzkoušejte vytvořit schéma pro svá data pomocí našeho bezplatného generátoru JSON Schema a validujte je živě!