Siirry sisältöön

JSON-skeemageneraattori

Luo JSON-skeema esimerkki-JSON:stä. Generaattori päättelee tyypit, pakolliset ominaisuudet, taulukkoalkioiden skeemat ja yleisiä merkkijonomuotoja, kuten päivämäärä-ajat, sähköpostiosoitteet, uri-osoitteet ja uuid-tunnisteet. Se tuottaa skeeman versiolle 2020-12, versiolle 2019-09 tai versiolle draft-07. Voit käyttää sitä pyyntöjen validointiin, API:n dokumentointiin tai lomakkeiden luomiseen.

Nollaa

Usein kysytyt kysymykset

Mitä JSON-skeemaversioita tuetaan?

Versio 2020-12 on nykyinen versio, jota OpenAPI 3.1 käyttää. Tuettuja ovat myös versio 2019-09 ja draft-07, joita monet vanhemmat validoijat ja työkalut yhä odottavat. Valinta määrittää $schema-skeeman URL-version; generaattorin tuottamat avainsanat tarkoittavat samaa kaikissa kolmessa.

Miten pakolliset ominaisuudet määritetään?

Ominaisuus merkitään pakolliseksi, jos se esiintyy kyseisen objektin jokaisessa näytteessä. Objektitaulukossa avain, joka puuttuu joistakin alkioista, jätetään pois pakollisten luettelosta. Poista valinta, jos haluat skeeman ilman pakollisten luetteloita.

Mitkä merkkijonomuodot tunnistetaan?

Tunnistettavat muodot ovat date-time, date, time, email, uri, uuid ja ipv4. Muoto lisätään vain, jos kaikki kyseisen ominaisuuden näytearvot vastaavat sitä. Yksikin vapaamuotoinen arvo jättää ominaisuuden tavalliseksi merkkijonoksi. Poista tunnistus käytöstä, jos et halua muotoavainsanoja.

Erottaako skeema kokonaisluvut desimaaliluvuista?

Kyllä. Ominaisuuden tyypiksi tulee integer, jos kaikki sen näytearvot ovat kokonaislukuja. Jos yksikin näytearvo sisältää murto-osan, tyypiksi tulee number, joka hyväksyy myös kokonaisluvut.

Miten taulukot kuvataan?

Taulukon tyypiksi tulee array, ja sen items-skeema muodostetaan kaikista alkioista yhdessä. Taulukon objektit yhdistetään, joten items-skeemaan merkitään kaikki avaimet, joita esiintyy yhdessäkin alkiossa. Pakollisiksi merkitään vain kaikissa alkioissa esiintyvät avaimet.

Mitä eri tyyppien yhdistelmille tapahtuu?

Jos ominaisuudella on eri tyyppisiä yksinkertaisia arvoja, kuten yhdessä alkiossa merkkijono ja toisessa null, skeema luettelee tyypit tyyppitaulukkona, esimerkiksi ["string", "null"]. Jos objektit tai taulukot yhdistyvät muihin tyyppeihin, generaattori käyttää anyOf-rakennetta, jossa on yksi skeema kutakin tyyppiä kohti.

Lisätäänkö skeemaan additionalProperties tai rajoituksia?

Ei. Näytteestä ei voi päätellä, mitkä ylimääräiset avaimet ovat kiellettyjä tai mitkä ovat todelliset vähimmäis- ja enimmäisarvot. Siksi generaattori jättää pois avainsanat additionalProperties, minLength, maximum ja vastaavat. Lisää ne käsin, jos datasi niitä tarvitsee.

Voinko validoida dataa tuloksella?

Kyllä. Liitä skeema ja datasi JSON Schema Validatoriin tai käytä tulosta esimerkiksi Ajv-kirjaston kanssa. Tarkista skeema ensin: se perustuu näytteeseesi, joten sitä on muokattava hieman, jos kenttä voi oikeassa datassa puuttua tai olla null mutta näin ei ole näytteessä.

Voinko käyttää skeemaa OpenAPIssa?

OpenAPI 3.1 käyttää suoraan JSON Schema 2020-12:ta, joten luotu skeema voidaan sijoittaa kohtaan components/schemas, kun olet poistanut rivin $schema. OpenAPI 3.0 käyttää vanhempaa osajoukkoa; siinä korvaa tyyppitaulukot nullable-arvolla.

Kuinka suuri syöte voi olla?

Enintään 1,000,000 merkkiä kohteesta JSON, sisäkkäisyys enintään 64 tasoa. Esimerkkiä analysoidaan vain tätä pyyntöä varten, eikä sitä tallenneta.

Tietoja: OneClick Pro

OneClick Pro on ilmainen kokoelma, jossa on yli 150 verkkotyökalua arjen tehtäviin: kuvien ja yksiköiden muuntamiseen, koodin muotoiluun ja validointiin, verkkotunnusten ja SEO tarkistamiseen sekä tekstien, päivämäärien ja lukujen käsittelyyn. Kaikki työkalut toimivat ilman rekisteröitymistä tai tilausta. Syöttämiäsi tietoja käytetään vain tuloksen laskemiseen, eikä niitä tallenneta koskaan. Käytä palvelua nopeana apuvälineenä yksittäisiin tehtäviin tai lisää kirjanmerkkeihin työkalut, joita tarvitset päivittäin.