Generátor JSON Schema z ukázkového JSONu
Vložte ukázkovou odpověď API a nástroj z ní odvodí schéma s typy, povinnými poli a formáty.
Ukázkový JSON
JSON Schema
K čemu je schéma dobré
JSON Schema popisuje, jak má dokument vypadat: jaké klíče v něm musí být, jakého jsou typu a co je nepovinné. Validátor pak vstup zkontroluje dřív, než se dostane do aplikace, a vrátí konkrétní chybu místo pádu někde uvnitř kódu.
Schéma se hodí i mimo validaci — z popisu se generuje dokumentace, typy pro TypeScript nebo testovací data. Pokud rozhraní popisujete v OpenAPI, používáte JSON Schema v podstatě také, jen zabalené do jiného formátu.
Co odvození z jedné ukázky nezachytí
Nástroj vidí jen ty klíče, které v příkladu skutečně jsou. Nepovinné pole, které v ukázce chybí, se do schématu nedostane, a naopak pole s hodnotou null dostane typ null, i když jinak bývá textové. U polí se typ odvodí podle prvního prvku.
Výstup berte jako kostru, kterou ještě upravíte: doladíte seznam required, doplníte minLength, minimum nebo výčet povolených hodnot přes enum. U typů, které mohou mít víc podob, se používá zápis "type": ["string", "null"].
Časté dotazy
Jaký je rozdíl mezi draftem 2020-12 a draft-07?
Liší se hlavně zápisem odkazů a prací s poli. Draft-07 je starší, ale podporuje ho víc knihoven. Když si nejste jistí, ověřte, co umí validátor, který budete používat.
Proč se z čísla 4 stane integer a z 4.5 number?
JSON nerozlišuje celá a desetinná čísla, rozhoduje tedy konkrétní hodnota v ukázce. Pokud může pole nabývat i desetinných hodnot, změňte typ ručně na number.
Kontroluje validátor formáty jako e-mail sám od sebe?
Ne vždy. Klíč format je v základu jen informativní a řada knihoven ho ověřuje, jen když zapnete přísný režim nebo doinstalujete rozšíření.