Preverjevalnik sheme JSON Schema

Kako preveriti JSON glede na shemo

1. Prilepi shemo v JSON Schema in podatke v Dokument JSON ali izberi pripravljen primer v Primer.
2. Pusti Različica (draft) na Samodejno ($schema), da se uporabi različica, ki jo poimenuje $schema sheme, ali pa vsili draft 4, 7, 2019-09 ali 2020-12.
3. Preverjanje teče med tipkanjem; Preveri ga zažene znova. Oblikuj oboje ponovno zamakne obe besedili.
4. Preberi rezultat: zelena vrstica, kadar je dokument veljaven, sicer tabela napak.

Branje tabele napak

Vsaka vrstica je eno neizpolnjeno pravilo:

• Pot v dokumentu je kazalec JSON Pointer na vrednost, ki ni uspela. /roles/1 je drugi element roles; (koren) je celoten dokument.
• Ključna beseda je pravilo sheme, ki ni uspelo: type, required, minimum, pattern, format, additionalProperties in tako naprej.
• Sporočilo pojasni neuspeh, na primer 0 is less than 1.
• Pot v shemi kaže na ključno besedo znotraj sheme, kot je /properties/id/minimum, tako da pravilo hitro najdeš.

Preverjanje se ne ustavi pri prvi težavi: navedene so vse napake. Ko lastnost objekta ne uspe, preverjevalnik javi povzetek (»Property “id” does not match schema«), ki mu sledi natančen razlog. Pokaži samo najbolj specifične napake skrije te povzetke; odznači jo, da vidiš celotno verigo. Napake pod anyOf in oneOf ostanejo vedno skupaj s specifičnimi napakami vsake veje, ker imajo smisel le skupaj.

Sporočila o napakah, ki jih ustvari preverjevalnik, so v angleščini.

Kaj je podprto

• Drafti: 4, 6 (preverjan s pravili drafta 7), 7, 2019-09 in 2020-12, vključno z $defs/definitions, lokalnim $ref, if/then/else, dependentRequired, dependentSchemas, prefixItems, unevaluatedProperties in unevaluatedItems.
• Formati: preverjeni so date, time, date-time, duration, email, hostname, ipv4, ipv6, uri, uri-reference, uri-template, uuid, regex, json-pointer in relative-json-pointer. Neznani formati so prezrti, kot dovoljuje specifikacija.
• Sklici: $ref lahko kaže kamor koli znotraj sheme, tudi na $id, ki ga shema razglasi. Oddaljene sheme se nikoli ne prenesejo; sklic na drug URL je javljen kot nerazrešen.

To orodje preverja dokumente glede na tvojo shemo. Ne preverja, ali sama shema sledi metashemi, vendar opozori na neznana imena type, kot sta "strin" ali "int", pogosto tipkarsko napako, ki jo preverjevalniki sicer tiho prezrejo.

Primeri

• Profil uporabnika (2020-12): required, dolžine nizov, format: email, enum znotraj items, uniqueItems in additionalProperties: false.
• Seznam izdelkov s $ref (draft-07): tabela, katere elementi se sklicujejo na #/definitions/product, s pattern za SKU in ceno z exclusiveMinimum.
• Konfiguracija z if/then (2019-09): potrdilo, zahtevano samo v načinu HTTPS, oneOf med e-pošto in URI ter številske omejitve.

Vsak primer ima dokument z namernimi napakami, da vidiš, kako izgledajo napake.