Mikä on JSON Schema?

JSON Schema kuvaa, miltä JSON-dokumentin pitäisi näyttää: mitä ominaisuuksia objektilla on, mitkä niistä ovat pakollisia, mikä kunkin arvon tyyppi on sekä sallitut arvoalueet ja pituudet, mallit ja muodot, kuten sähköpostiosoitteet tai päivämäärät. API-rajapinnat, asetustiedostot ja lomaketyökalut tarkistavat skeemojen avulla tiedot ennen kuin ne luottavat niihin, ja OpenAPI kuvaa niiden avulla pyyntöjen ja vastausten sisällöt.

Validatorin käyttö

  1. Liitä tai kirjoita JSON Schema ensimmäiseen kenttään.
  2. Liitä tai kirjoita tarkistettavat JSON-tiedot toiseen kenttään.
  3. Tulos näkyy kirjoittaessasi: joko JSON on kelvollinen tai kaikki virheet luetellaan. Kunkin virheen yhteydessä näytetään virheellisen arvon polku, rikottu skeeman avainsana ja lyhyt selitys.
  4. Jokainen virheellinen arvo merkitään tietoihin. Napsauta virhettä, niin siirryt kyseiseen kohtaan tiedoissa. Voit myös napsauttaa merkintää löytääksesi sitä vastaavan virheen luettelosta.

Skeemaversion kenttä näyttää, minkä JSON Schema -luonnoksen mukaan tiedot tarkistettiin.

Tuetut luonnokset

Skeeman $schema-avainsana määrittää käytettävän luonnoksen:

  • Luonnos 2020-12: https://json-schema.org/draft/2020-12/schema
  • Luonnos 2019-09: https://json-schema.org/draft/2019-09/schema
  • Luonnos 7: http://json-schema.org/draft-07/schema#
  • Luonnos 6: http://json-schema.org/draft-06/schema#

Skeema, jossa ei ole $schema-avainsanaa, tarkistetaan luonnoksen 7 mukaan. Luonnosta 4 ja sitä vanhempia luonnoksia ei tueta. Skeema tarkistetaan ensin sen luonnoksen metaskeemaa vasten, joten esimerkiksi kirjoitusvirhe "type": "strin" ilmoitetaan virheellisenä skeemana eikä sitä sivuuteta. Merkinnät, kuten title, description ja examples, ovat sallittuja, samoin kuin luonnokselle tuntemattomat avainsanat, kuten omat x--merkintäsi: ne sivuutetaan.

Virheiden lukeminen

  • Polut kirjoitetaan JSONPath-muodossa alkaen merkistä $, joka viittaa koko dokumenttiin: $.ingredients[1].unit tarkoittaa toisen ainesosan unit-ominaisuutta.
  • Puuttuva pakollinen ominaisuus ilmoitetaan objektin kohdalla, jossa sen pitäisi olla. Viestissä kerrotaan ominaisuuden nimi.
  • Skeeman kieltämä ylimääräinen ominaisuus osoitetaan sen nimen kohdalla.
  • enum- ja const-avainsanojen kohdalla viestissä luetellaan sallitut arvot.
  • anyOf- ja oneOf-avainsanojen kohdalla jokainen epäonnistuva haara lisää omat virheensä, minkä jälkeen lisätään vielä virhe itse avainsanasta. Siksi yksi virheellinen arvo voi aiheuttaa useita virheitä.

Virheilmoitukset ovat Ajv-kirjastosta, ja ne ovat englanniksi.

Muodot

Myös format-arvolla merkityt arvot tarkistetaan: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer ja muita. Jos validator ei tunne muotoa, se sivuutetaan, kuten JSON Schema -määritys sallii.

Viittaukset

$ref toimii saman skeeman sisäisiin määritelmiin, kuten #/$defs/address tai #/definitions/address. Viittauksia muihin tiedostoihin tai URL-osoitteisiin ei haeta: jos skeema tarvitsee tällaista viittausta, se ilmoitetaan virheelliseksi ja samalla kerrotaan, mitä viittausta ei voitu ratkaista.

Miten se toimii

Työkalu tarkistaa tiedot Ajv:llä, joka on laajalti käytetty JSON Schema -validator, ja tarkistaa muodot ajv-formatsilla. Kaikki tapahtuu selaimessasi: skeemaa ja tietoja ei koskaan lähetetä palvelimelle.

Ominaisuudet

  • JSON Schema -luonnokset 6, 7, 2019-09 ja 2020-12 valitaan $schema-arvon perusteella
  • Jokainen virhe ja sen polku, avainsana ja viesti
  • Virheelliset arvot merkitään tietoihin, ja napsauttamalla siirryt niiden kohdalle
  • Sähköpostiosoitteiden, URI-osoitteiden, päivämäärien, UUID-tunnisteiden, IP-osoitteiden ja muiden muotojen tarkistus
  • Skeema tarkistetaan metaskeemaa vasten
  • JSON-syntaksivirheiden rivi- ja sarakenumerot
  • Toimii selaimessasi