Liigu sisu juurde

JSON skeemigeneraator

Looge näidise JSON põhjal JSON skeem. Generaator tuletab tüübid, kohustuslikud omadused, massiivi elementide skeemid ja levinud stringivormingud, näiteks kuupäev-kellaaeg, e-post, uri ja uuid, ning koostab skeemi draft 2020-12, 2019-09 või draft-07 jaoks. Saate seda kasutada päringute valideerimiseks, API dokumenteerimiseks või vormide loomiseks.

Lähtesta

Korduma kippuvad küsimused

Milliseid JSON skeemidrafte toetatakse?

Draft 2020-12, mida kasutab OpenAPI 3.1 ja mis on praegune versioon, draft 2019-09 ning draft-07, mida paljud vanemad valideerijad ja tööriistad endiselt eeldavad. Valik määrab $schema URL; generaatori kirjutatud märksõnad tähendavad kõigis kolmes sama.

Kuidas otsustatakse, millised omadused on kohustuslikud?

Omadus lisatakse required-loendisse, kui see esineb selle objekti igas näidises. Objektide massiivis jäetakse required-loendist välja võti, mis mõnes elemendis puudub. Lülitage see valik välja, et koostada skeem ilma ühegi required-loendita.

Millised stringivormingud tuvastatakse?

date-time, date, time, email, uri, uuid ja ipv4. Vorming lisatakse ainult siis, kui kõik selle omaduse näidisväärtused sellele vastavad; üks vaba tekstina esitatud väärtus jätab omaduse tavaliseks stringiks. Lülitage tuvastamine välja, kui te ei soovi vormingumärksõnu.

Kas skeem eristab täisarve kümnendarvudest?

Jah. Kui omaduse kõik näidisväärtused on täisarvud, saab selle tüübiks integer. Kui kas või ühel näidisväärtusel on murdosa, saab tüübiks number, mis lubab ka täisarve.

Kuidas massiive kirjeldatakse?

Massiiv saab tüübiks array ning kõigi selle elementide põhjal koostatud items-skeemi. Massiivi objektid ühendatakse, nii et items-skeem loetleb kõik võtmed, mis esinevad vähemalt ühes elemendis; required-loendisse lähevad vaid kõigis elementides esinevad võtmed.

Mis juhtub eri tüüpi väärtustega?

Kui omadus sisaldab lihtväärtusi eri tüüpidest, näiteks ühes elemendis stringi ja teises nulli, loetleb skeem need tüüpide massiivina, näiteks ["string", "null"]. Kui objektide või massiividega on segatud muid tüüpe, kasutab generaator märksõna anyOf ja lisab iga tüübi jaoks oma skeemi.

Kas generaator lisab additionalProperties'i või piiranguid?

Ei. Näidise põhjal ei saa teada, millised lisavõtmed on keelatud või millised on tegelikud miinimum- ja maksimumväärtused, seega jätab generaator välja märksõnad additionalProperties, minLength, maximum ja muud sarnased. Lisage need käsitsi, kui teie andmed neid vajavad.

Kas saan tulemusega andmeid valideerida?

Jah. Kleepige skeem ja oma andmed JSON Schema Validatorisse või kasutage neid teegiga, näiteks Ajv-ga. Kontrollige skeem enne üle: see peegeldab teie näidist, nii et välja, mis võib pärisandmetes puududa või olla null, kuid näidises seda pole, tuleb veidi muuta.

Kas saan skeemi OpenAPI-s kasutada?

OpenAPI 3.1 kasutab JSON skeemi 2020-12 otse, seega saab loodud skeemi lisada jaotisse components/schemas pärast $schema rea eemaldamist. OpenAPI 3.0 kasutab vanemat alamhulka; seal asenda tüübimassiivid atribuudiga nullable.

Kui suur võib sisend olla?

Kuni 1,000,000 märki JSON kohta, pesastatuna kuni 64 tasemeni. Näidist analüüsitakse ainult selle päringu jaoks ja seda ei salvestata.

Teave OneClick Pro kohta

OneClick Pro on tasuta kollektsioon, mis sisaldab üle 150 veebitööriista igapäevatööks: piltide ja ühikute teisendamiseks, koodi vormindamiseks ja valideerimiseks, domeenide ja SEO kontrollimiseks ning teksti, kuupäevade ja numbritega töötamiseks. Kõik tööriistad toimivad ilma registreerimise või tellimuseta ning sisestatut kasutatakse ainult tulemuse arvutamiseks ega salvestata kunagi. Kasutage seda kiire tööriistakastina ühekordsete ülesannete jaoks või lisage järjehoidjatesse tööriistad, mida iga päev kasutate.