Přejít k obsahu

Generátor schématu JSON

Vytvořte schéma JSON z ukázkového JSON. Generátor odvodí typy, povinné vlastnosti, schémata položek polí a běžné formáty řetězců, jako jsou date-time, email, uri a uuid. Zapíše schéma pro draft 2020-12, 2019-09 nebo draft-07, které můžete použít k ověření požadavků, dokumentaci API nebo generování formulářů.

Obnovit

Často kladené otázky

Které verze schématu JSON jsou podporovány?

Draft 2020-12, aktuální verze používaná OpenAPI 3.1, draft 2019-09 a draft-07, které stále očekává mnoho starších validátorů a nástrojů. Výběr nastaví $schema URL; klíčová slova, která generátor zapisuje, mají ve všech třech stejný význam.

Jak se určuje, které vlastnosti jsou povinné?

Vlastnost se uvede mezi povinnými, pokud se vyskytuje v každém vzorku daného objektu. V poli objektů se klíč, který v některých položkách chybí, mezi povinné nezařadí. Vypnutím této možnosti vytvoříte schéma bez seznamů povinných vlastností.

Které formáty řetězců se rozpoznávají?

date-time, date, time, email, uri, uuid a ipv4. Formát se přidá jen tehdy, když mu odpovídají všechny ukázkové hodnoty dané vlastnosti. Jedna hodnota s volným textem proto ponechá vlastnost jako běžný řetězec. Pokud klíčová slova formátu nechcete, vypněte rozpoznávání.

Rozlišuje schéma celá a desetinná čísla?

Ano. Vlastnost, jejíž vzorky jsou všechny celá čísla, získá typ integer. Jakmile má jeden vzorek desetinnou část, typ se změní na number, který přijímá i celá čísla.

Jak se popisují pole?

Pole získá typ array a schéma položek sestavené ze všech jeho prvků dohromady. Objekty v poli se sloučí, takže schéma položek uvede všechny klíče vyskytující se v kterémkoli prvku; jako povinné označí jen klíče přítomné ve všech.

Co se stane při kombinaci různých typů?

Pokud vlastnost obsahuje jednoduché hodnoty různých typů, například řetězec v jedné položce a null v jiné, schéma je uvede jako pole typů, například ["string", "null"]. Pokud se objekty nebo pole kombinují s jinými typy, generátor použije anyOf s jedním schématem pro každý typ.

Přidává additionalProperties nebo omezení?

Ne. Ze vzorku nelze zjistit, které další klíče jsou zakázané ani jaké jsou skutečné minimální a maximální hodnoty. Generátor proto vynechá additionalProperties, minLength, maximum a podobná klíčová slova. Přidejte je ručně podle potřeb svých dat.

Mohu pomocí výsledku ověřovat data?

Ano. Vložte schéma a svá data do JSON Schema Validator nebo použijte knihovnu, jako je Ajv. Nejdřív schéma zkontrolujte: odpovídá vašemu vzorku, takže pokud může pole ve skutečných datech chybět nebo být null, ale ve vzorku tomu tak není, bude třeba schéma drobně upravit.

Mohu schéma použít v OpenAPI?

OpenAPI 3.1 používá přímo JSON Schema 2020-12, takže vygenerované schéma můžete vložit pod components/schemas poté, co odstraníte řádek $schema. OpenAPI 3.0 používá starší podmnožinu; v takovém případě nahraďte pole type hodnotou nullable.

Jak velký může být vstup?

Až 1,000,000 znaků JSON, vnořených až do 64 úrovní. Ukázka se analyzuje pouze pro tento požadavek a neukládá se.

O OneClick Pro

OneClick Pro je bezplatná kolekce více než 150 webových nástrojů pro každodenní práci: převod obrázků a jednotek, formátování a ověřování kódu, kontrolu domén a SEO i práci s textem, daty a čísly. Každý nástroj funguje bez registrace či předplatného a zadané údaje se používají pouze k výpočtu výsledku a nikdy se neukládají. Používejte ji jako rychlou sadu nástrojů pro jednorázové úkoly nebo si uložte do záložek nástroje, na které se každý den spoléháte.