Vad är ett JSON Schema?

Ett JSON Schema beskriver hur ett JSON-dokument ska se ut: vilka egenskaper ett objekt har, vilka av dem som krävs, vilken typ varje värde har, tillåtna intervall och längder samt mönster och format, till exempel e-postadresser eller datum. API:er, konfigurationsfiler och formulärbyggare använder scheman för att kontrollera data innan de litar på den, och OpenAPI beskriver förfrågningars och svarens innehåll med hjälp av dem.

Så använder du validatorn

  1. Klistra in eller skriv JSON Schema i den första rutan.
  2. Klistra in eller skriv JSON-data att kontrollera i den andra rutan.
  3. Resultatet visas medan du skriver: antingen är JSON giltig, eller så listas alla fel med sökvägen till värdet som inte klarar kontrollen, nyckelordet i schemat som det bryter mot och en kort förklaring.
  4. Varje värde som inte klarar kontrollen markeras i data. Klicka på ett fel för att rulla till det i data, eller klicka på en markering för att hitta felet i listan.

Fältet Schemalversion visar vilket utkast av JSON Schema som data kontrollerades mot.

Vilka utkast stöds

Schemat väljer utkast med nyckelordet $schema:

  • 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#

Ett schema utan $schema kontrolleras som utkast 7. Utkast 4 och äldre stöds inte. Själva schemat kontrolleras först mot utkastets metaschema, så ett skrivfel som "type": "strin" rapporteras som ett ogiltigt schema i stället för att ignoreras. Kommentarer som title, description och examples är tillåtna, liksom nyckelord som utkastet inte känner igen, till exempel dina egna x--kommentarer: de ignoreras.

Så läser du felen

  • Sökvägar skrivs som JSONPath, med start från $, hela dokumentet: $.ingredients[1].unit är egenskapen unit för den andra ingrediensen.
  • En saknad obligatorisk egenskap rapporteras för objektet som ska ha den, och egenskapens namn anges i meddelandet.
  • En extra egenskap som schemat inte tillåter pekar på egenskapens namn.
  • För enum och const räknar meddelandet upp de tillåtna värdena.
  • Med anyOf och oneOf ger varje gren som inte klarar kontrollen upphov till egna fel, följt av ett fel för själva nyckelordet. Därför kan ett felaktigt värde ge upphov till flera fel.

Felmeddelandena kommer från biblioteket Ajv och är på engelska.

Format

Värden med ett format kontrolleras också: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer med flera. Ett format som validatorn inte känner igen ignoreras, vilket JSON Schema-specifikationen tillåter.

Referenser

$ref fungerar för definitioner i samma schema, till exempel #/$defs/address eller #/definitions/address. Referenser till andra filer eller URL:er hämtas inte: ett schema som behöver en sådan rapporteras som ogiltigt, tillsammans med referensen som inte kunde lösas.

Så fungerar det

Verktyget validerar med Ajv, en ofta använd validator för JSON Schema, och kontrollerar format med ajv-formats. Allt körs i din webbläsare: schemat och data laddas aldrig upp.

Funktioner

  • Stöd för utkast 6, 7, 2019-09 och 2020-12 av JSON Schema, valda med $schema
  • Alla fel visas med sökväg, nyckelord och meddelande
  • Värden som inte klarar kontrollen markeras i data, med klickfunktion för att rulla till dem
  • Formatkontroller för e-postadresser, URI:er, datum, UUID:er, IP-adresser med mera
  • Schemat kontrolleras mot sitt metaschema
  • Rad och kolumn för JSON-syntaxfel
  • Körs i din webbläsare