Mitä JSON Schema -generaattori tekee?

Se kirjoittaa JSON Schema -skeeman puolestasi esimerkin perusteella. Liitä näyte, kuten API-vastaus, asetustiedosto tai tietokantaviennistä peräisin oleva tietue, niin saat skeeman, joka kuvaa sen rakenteen: jokaisen arvon tyypin, jokaisen objektin ominaisuudet, jokaisen taulukon alkioiden rakenteen sekä pakolliset ominaisuudet. Se on nopea lähtökohta API-dokumentaatiolle, OpenAPI-määrityksille, lomakkeiden validoinnille tai datan sopimuksille, joita voit sitten tarkentaa käsin.

Käyttöohjeet

  1. Liitä tai kirjoita esimerkin JSON syötekenttään.
  2. Valitse $schema-riville JSON Schema -luonnos: Draft 2020-12 tai Draft 7.
  3. Valitse, merkitäänkö ominaisuudet pakollisiksi.
  4. Kopioi skeema tai lataa se nimellä schema.json.

Jos näyte ei ole kelvollista JSONia, työkalu ilmoittaa ongelman rivin ja sarakkeen sekä merkitsee sen.

Miten skeema muodostetaan

  • Jokainen arvo saa JSON-tyypin: string, boolean, null, object, array ja kokonaisluvuille integer tai desimaaliluvuille number. Kokonaislukuja ja desimaalilukuja sisältävä taulukko saa tyypin number, joka kattaa molemmat.
  • Jokaiselle objektin avaimelle luodaan properties-merkintä, joka kuvataan samalla tavalla niin syvälle kuin näyte ulottuu.
  • Taulukoille luodaan yksi items-skeema, joka sopii kaikkiin alkioihin. Kun alkiot ovat objekteja, niiden ominaisuudet yhdistetään, joten tietueluettelo tuottaa yhden tietueen skeeman.
  • Eri tyyppiset arvot saavat kaikki tyypit sisältävän luettelon, kuten ["string", "null"], tai anyOf-määrityksen, kun mukana on sekä objekteja että muita arvoja.
  • Tyhjä taulukko saa määrityksen "type": "array" ilman items-määritystä, koska kuvattavia alkioita ei ole.

Pakolliset ominaisuudet

Kun asetus ”Merkitse ominaisuudet pakollisiksi” on käytössä, kunkin objektin avaimet luetellaan kohdassa required. Objektitaulukossa ominaisuus on pakollinen vain, jos se esiintyy jokaisessa alkiossa: jos jäsenluettelossa vain osalla on favorite-ominaisuus, se on valinnainen. Poista asetus käytöstä, jos haluat skeeman ilman required-luetteloita.

Mitä näytteestä ei voi päätellä

Yhdestä esimerkistä muodostettu skeema tuntee vain sen, mitä esimerkissä näkyy. Se ei voi tietää, mitkä merkkijonoarvot ovat sähköpostiosoitteita tai päivämääriä, mitä vaihteluvälejä luvut voivat saada tai voiko kerran esiintyvä ominaisuus myös puuttua. Lisää tarvittaessa käsin format, minimum, maxLength, enum tai pattern ja tarkista data tulosta vasten JSON Schema -validaattorilla.

Toimintaperiaate

Työkalu käyttää genson-js:ää, joka on GenSON-skeemarakentajan JavaScript-porttaus. Sen kirjoittamat avainsanat tarkoittavat samaa Draft 7:ssä ja Draft 2020-12:ssa, joten luonnos vaikuttaa vain $schema-riviin. Kaikki suoritetaan selaimessasi: näytettä ei koskaan lähetetä palvelimelle.

Ominaisuudet

  • JSON Schema mistä tahansa JSON-näytteestä
  • Tyyppien, sisäkkäisten objektien ja taulukoiden määritys automaattisesti
  • Taulukon alkiot yhdistetään yhdeksi skeemaksi, ja valinnaiset ominaisuudet tunnistetaan
  • Draft 2020-12 tai Draft 7
  • Pakolliset ominaisuudet käytössä tai pois käytöstä
  • Kopiointi tai lataus nimellä schema.json
  • Toimii selaimessasi