JSON Schema valideerija

Kuidas JSON-i skeemi vastu valideerida

1. Kleebi skeem väljale JSON Schema ja andmed väljale JSON-dokument või vali valmis juhtum jaotisest Näide.
2. Jäta Versioon väärtusele Automaatne ($schema), et kasutada skeemi $schema nimetatud versiooni, või sunni peale draft 4, 7, 2019-09 või 2020-12.
3. Valideerimine töötab kirjutamise ajal; Valideeri käivitab selle uuesti. Vorminda mõlemad taandab mõlemad tekstid uuesti.
4. Loe tulemust: roheline rida, kui dokument on korrektne, muidu veatabel.

Veatabeli lugemine

Iga rida on üks ebaõnnestunud reegel:

• Eksemplari tee on JSON Pointer väärtuseni, mis ebaõnnestus. /roles/1 on roles teine element; (juur) on kogu dokument.
• Võtmesõna on skeemi reegel, mis ebaõnnestus: type, required, minimum, pattern, format, additionalProperties jne.
• Teade selgitab ebaõnnestumist, näiteks 0 is less than 1.
• Skeemi tee viitab võtmesõnale skeemi sees, näiteks /properties/id/minimum, et saaksid reegli kiiresti üles leida.

Valideerimine ei peatu esimesel probleemil: kõik vead loetletakse. Kui objekti omadus ebaõnnestub, teatab valideerija kokkuvõtte („Property “id” does not match schema“), millele järgneb täpne põhjus. Näita ainult kõige täpsemaid vigu peidab need kokkuvõtted; võta märge maha, et näha kogu ahelat. Vead anyOf ja oneOf all hoitakse alati koos iga haru täpsete vigadega, sest need on mõistlikud ainult koos.

Mida toetatakse

• Versioonid: 4, 6 (valideeritakse draft 7 reeglitega), 7, 2019-09 ja 2020-12, sealhulgas $defs/definitions, kohalik $ref, if/then/else, dependentRequired, dependentSchemas, prefixItems, unevaluatedProperties ja unevaluatedItems.
• Vormingud: kontrollitakse date, time, date-time, duration, email, hostname, ipv4, ipv6, uri, uri-reference, uri-template, uuid, regex, json-pointer ja relative-json-pointer. Tundmatud vormingud ignoreeritakse, nagu spetsifikatsioon lubab.
• Viited: $ref võib osutada kuhu tahes skeemi sees, sealhulgas selles deklareeritud $id-le. Kaugskeeme ei laadita kunagi alla; viide teisele URL-ile teatatakse lahendamata viitena.

See tööriist valideerib dokumente sinu skeemi vastu. See ei kontrolli, kas skeem ise järgib metaskeemi, kuid hoiatab tundmatute type nimede eest, nagu "strin" või "int", mis on levinud kirjaviga, mida valideerijad muidu vaikselt ignoreerivad.

Näited

• Kasutajaprofiil (2020-12): required, stringide pikkused, format: email, enum elementide sees, uniqueItems ja additionalProperties: false.
• Tootenimekiri koos $ref-iga (draft-07): massiiv, mille elemendid viitavad #/definitions/product, koos SKU pattern-iga ja exclusiveMinimum hinnaga.
• Seadistus if/then-iga (2019-09): sertifikaat nõutav ainult HTTPS-režiimis, oneOf e-posti ja URI vahel ning arvulised piirid.

Iga näide tuleb dokumendiga, mis sisaldab tahtlikke vigu, et näeksid, milline veateade välja näeb.