Hva er et JSON Schema?

Et JSON Schema beskriver hvordan et JSON-dokument skal se ut: hvilke egenskaper et objekt har, hvilke av dem som er obligatoriske, typen til hver verdi, tillatte intervaller og lengder, mønstre og formater som e-postadresser eller datoer. API-er, konfigurasjonsfiler og skjemabyggere bruker schemaer til å kontrollere data før de stoler på dem, og OpenAPI beskriver forespørsels- og svarinnhold med dem.

Slik bruker du validatoren

  1. Lim inn eller skriv JSON Schema i den første boksen.
  2. Lim inn eller skriv JSON-dataene du vil kontrollere, i den andre boksen.
  3. Resultatet vises mens du skriver: Enten er JSON gyldig, eller så vises alle feilene sammen med stien til verdien som ikke består kontrollen, schema-nøkkelordet den bryter med, og en kort forklaring.
  4. Hver verdi som ikke består kontrollen, markeres i dataene. Klikk på en feil for å bla til den aktuelle verdien i dataene, eller klikk på en markering for å finne feilen i listen.

Feltet for Schema-versjon viser hvilket utkast av JSON Schema dataene ble kontrollert mot.

Hvilke utkast støttes

Schemaets $schema-nøkkelord velger utkastet:

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

Et schema uten $schema kontrolleres som utkast 7. Utkast 4 og eldre støttes ikke. Selve schemaet kontrolleres først mot utkastets meta-schema, slik at en skrivefeil som "type": "strin" rapporteres som et ugyldig schema i stedet for å bli ignorert. Merknader som title, description og examples er tillatt, og det samme gjelder nøkkelord utkastet ikke kjenner til, for eksempel dine egne x--merknader: De ignoreres.

Slik leser du feilene

  • Stier skrives som JSONPath og starter fra $, som viser til hele dokumentet: $.ingredients[1].unit er unit-verdien til den andre ingrediensen.
  • En manglende obligatorisk egenskap rapporteres på objektet som skulle hatt den, og egenskapens navn vises i meldingen.
  • En ekstra egenskap som schemaet ikke tillater, peker på navnet til den egenskapen.
  • For enum og const viser meldingen de tillatte verdiene.
  • Med anyOf og oneOf legger hver gren som ikke består kontrollen, til sine egne feil, etterfulgt av en feil for selve nøkkelordet. Dermed kan én feil verdi føre til flere feil.

Feilmeldingene kommer fra Ajv-biblioteket og er på engelsk.

Formater

Verdier med et format kontrolleres også: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer og flere. Et format validatoren ikke kjenner til, ignoreres, slik JSON Schema-spesifikasjonen tillater.

Referanser

$ref fungerer for definisjoner i samme schema, for eksempel #/$defs/address eller #/definitions/address. Referanser til andre filer eller URL-er hentes ikke: Et schema som trenger en slik referanse, rapporteres som ugyldig, sammen med referansen som ikke kunne løses.

Slik fungerer det

Verktøyet validerer med Ajv, en mye brukt JSON Schema-validator, og kontrollerer formater med ajv-formats. Alt kjøres i nettleseren din: Schemaet og dataene lastes aldri opp.

Funksjoner

  • Støtte for JSON Schema-utkast 6, 7, 2019-09 og 2020-12, valgt fra $schema
  • Alle feil vises med sti, nøkkelord og melding
  • Verdier som ikke består kontrollen, markeres i dataene, og du kan klikke for å bla til dem
  • Formatkontroller for e-postadresser, URI-er, datoer, UUID-er, IP-adresser og mer
  • Schemaet kontrolleres mot meta-schemaet
  • Linje og kolonne for JSON-syntaksfeil
  • Kjøres i nettleseren din