Generator shem JSON
Ustvarite shemo JSON iz vzorca JSON. Generator sklepa o tipih, obveznih lastnostih, shemah elementov tabel in pogostih oblikah nizov, kot so date-time, email, uri in uuid, ter zapiše shemo za osnutek 2020-12, 2019-09 ali draft-07, ki jo lahko uporabite za preverjanje zahtev, dokumentiranje API ali ustvarjanje obrazcev.
Pogosta vprašanja
Kateri osnutki shem JSON so podprti?
Draft 2020-12, trenutno različico, ki jo uporablja OpenAPI 3.1, draft 2019-09 in draft-07, ki ju še vedno pričakujejo številni starejši validatorji in orodja. Izbira nastavi $schema URL; ključne besede, ki jih zapiše generator, pomenijo enako v vseh treh različicah.
Kako se določijo obvezne lastnosti?
Lastnost je navedena med obveznimi, če se pojavi v vsakem vzorcu tega objekta. V tabeli objektov je ključ, ki v nekaterih elementih manjka, izpuščen s seznama obveznih. Izklopite možnost, če želite zapisati shemo brez seznamov obveznih lastnosti.
Katere oblike nizov se zaznajo?
date-time, date, time, email, uri, uuid in ipv4. Oblika je dodana samo, če ji ustreza vsaka vzorčna vrednost te lastnosti, zato ena vrednost s prostim besedilom ohrani lastnost kot navaden niz. Zaznavanje izklopite, če ne želite ključnih besed za oblike.
Ali shema razlikuje med celimi in decimalnimi števili?
Da. Lastnost, katere vzorčne vrednosti so vse cela števila, dobi tip integer. Takoj ko ima ena vzorčna vrednost decimalni del, postane tip number, ki sprejema tudi cela števila.
Kako so opisane tabele?
Tabela dobi tip array in shemo items, zgrajeno iz vseh njenih elementov skupaj. Objekti v tabeli se združijo, zato shema elementov navede vse ključe, ki se pojavijo v katerem koli elementu, med obveznimi pa so le ključi, ki se pojavijo v vseh.
Kaj se zgodi pri mešanih tipih?
Če ima lastnost preproste vrednosti različnih tipov, na primer niz v enem elementu in null v drugem, jih shema navede kot tabelo tipov, na primer ["string", "null"]. Če so objekti ali tabele združeni z drugimi tipi, generator uporabi anyOf z ločeno shemo za vsak tip.
Ali doda additionalProperties ali omejitve?
Ne. Vzorec ne more pokazati, kateri dodatni ključi so prepovedani ali kakšne so dejanske najmanjše in največje vrednosti, zato generator izpusti additionalProperties, minLength, maximum in podobne ključne besede. Kjer jih vaši podatki potrebujejo, jih dodajte ročno.
Ali lahko z rezultatom preverim podatke?
Da. Prilepite shemo in svoje podatke v JSON Validator shem ali pa jo uporabite s knjižnico, kot je Ajv. Najprej preverite shemo: odraža vaš vzorec, zato je treba manjkajoče ali null vrednosti, ki se lahko pojavijo v resničnih podatkih, v vzorcu pa jih ni, urediti z manjšo spremembo.
Ali lahko shemo uporabim v OpenAPI?
OpenAPI 3.1 neposredno uporablja shemo JSON-12 2020, zato lahko ustvarjeno shemo po odstranitvi vrstice $schema dodate pod components/schemas. OpenAPI 3.0 uporablja starejšo podmnožico; tam zamenjajte polja type z nullable.
Kako velik je lahko vhod?
Do 1,000,000 znakov JSON, gnezdenje do 64 ravni. Vzorec se analizira samo za to zahtevo in se ne shrani.