Generátor schém JSON
Vygenerujte schému JSON z ukážkového JSON. Generátor odvodí typy, povinné vlastnosti, schémy položiek polí a bežné formáty reťazcov, ako sú dátum a čas, e-mail, uri a uuid, a vytvorí schému pre draft 2020-12, 2019-09 alebo draft-07, ktorú môžete použiť na validáciu požiadaviek, dokumentáciu API alebo generovanie formulárov.
Často kladené otázky
Ktoré verzie schém JSON sú podporované?
Draft 2020-12, aktuálna verzia používaná v OpenAPI 3.1, draft 2019-09 a draft-07, ktoré stále vyžadujú mnohé staršie validátory a nástroje. Výber určuje $schema URL; kľúčové slová, ktoré generátor zapisuje, majú vo všetkých troch rovnaký význam.
Ako sa určujú povinné vlastnosti?
Vlastnosť sa uvedie v zozname required, ak sa vyskytuje v každej ukážke daného objektu. V poli objektov sa kľúč, ktorý v niektorých položkách chýba, do zoznamu required nezaradí. Vypnutím tejto možnosti vytvoríte schému bez zoznamov required.
Ktoré formáty reťazcov sa rozpoznávajú?
date-time, date, time, email, uri, uuid a ipv4. Formát sa pridá iba vtedy, keď mu zodpovedajú všetky ukážkové hodnoty danej vlastnosti, takže jedna hodnota s voľným textom ponechá vlastnosť ako obyčajný reťazec. Ak nechcete kľúčové slová formátu, vypnite rozpoznávanie.
Rozlišuje schéma celé a desatinné čísla?
Áno. Vlastnosť, ktorej ukážkové hodnoty sú všetky celé čísla, dostane typ integer. Len čo má jedna ukážka desatinnú časť, typ sa zmení na number, ktorý prijíma aj celé čísla.
Ako sa opisujú polia?
Pole dostane typ array a schému items vytvorenú spoločne zo všetkých jeho prvkov. Objekty v poli sa zlúčia, takže schéma položiek uvádza každý kľúč vyskytujúci sa v ktoromkoľvek prvku; zoznam required obsahuje iba kľúče, ktoré sa vyskytujú vo všetkých.
Čo sa stane pri zmiešaných typoch?
Ak vlastnosť obsahuje jednoduché hodnoty rôznych typov, napríklad reťazec v jednej položke a null v inej, schéma ich uvedie ako pole typov, napríklad ["string", "null"]. Ak sa objekty alebo polia kombinujú s inými typmi, generátor použije anyOf s jednou schémou pre každý typ.
Pridáva sa additionalProperties alebo obmedzenia?
Nie. Z ukážky nemožno zistiť, ktoré ďalšie kľúče sú zakázané ani aké sú skutočné minimálne a maximálne hodnoty, preto generátor vynecháva additionalProperties, minLength, maximum a podobné kľúčové slová. Podľa potreby vašich údajov ich pridajte ručne.
Môžem pomocou výsledku validovať údaje?
Áno. Vložte schému a svoje údaje do validátora schém JSON alebo ju použite s knižnicou, ako je Ajv. Najprv schému skontrolujte: odráža vašu ukážku, takže ak vlastnosť v skutočných údajoch môže chýbať alebo mať hodnotu null, no v ukážke to tak nie je, bude potrebná drobná úprava.
Môžem použiť schému v OpenAPI?
OpenAPI 3.1 používa priamo JSON Schema 2020-12, takže vygenerovanú schému môžete po odstránení riadka $schema vložiť do components/schemas. OpenAPI 3.0 používa staršiu podmnožinu; v nej nahraďte polia type poľami nullable.
Aký veľký môže byť vstup?
Najviac 1,000,000 znakov reťazca JSON, vnoreného do 64 úrovní. Ukážka sa analyzuje iba pre túto požiadavku a neukladá sa.