Hva gjør JSON Schema-generatoren?

Den skriver et JSON Schema for deg basert på et eksempel på dataene dine. Lim inn et eksempel, for eksempel et API-svar, en konfigurasjonsfil eller en post fra en databaseeksport, så får du et schema som beskriver strukturen: typen til hver verdi, egenskapene til hvert objekt, hvordan elementene i hver liste ser ut, og hvilke egenskaper som er påkrevd. Det gir deg en rask start på API-dokumentasjon, OpenAPI-spesifikasjoner, skjemavalidering eller datakontrakter, som du deretter kan finjustere manuelt.

Slik bruker du verktøyet

  1. Lim inn eller skriv inn eksempel-JSON i inndatafeltet.
  2. Velg JSON Schema-utkastet for $schema-linjen: Utkast 2020-12 eller Utkast 7.
  3. Velg om egenskaper skal markeres som påkrevd.
  4. Kopier schemaet eller last det ned som schema.json.

Hvis eksempelet ikke er gyldig JSON, viser verktøyet linjen og kolonnen der problemet oppstår, og markerer det.

Slik utledes schemaet

  • Hver verdi får en JSON-type: string, boolean, null, object, array og integer for heltall eller number for desimaltall. En liste med heltall og desimaltall får typen number, som dekker begge deler.
  • Hvert objekt får en properties-oppføring for hver nøkkel, beskrevet på samme måte, så dypt som eksempelet går.
  • Hver liste får ett items-schema som passer til alle elementene. Når elementene er objekter, slås egenskapene deres sammen, slik at en liste med poster gir ett schema for en post.
  • Verdier med blandede typer får alle typene i en liste, for eksempel ["string", "null"], eller en anyOf når objekter blandes med andre verdier.
  • En tom liste får "type": "array" uten items, siden det ikke er noe å beskrive.

Påkrevde egenskaper

Når «Marker egenskaper som påkrevd» er slått på, listes nøklene til hvert objekt under required. For en liste med objekter er en egenskap bare påkrevd når hvert element har den: I en liste med medlemmer der bare noen har en favorite, er denne egenskapen valgfri. Slå av alternativet for å få et schema uten required-lister.

Dette kan ikke utledes fra et eksempel

Et schema som er laget fra ett eksempel, kjenner bare til det eksempelet viser. Det kan ikke vite hvilke strengverdier som er e-postadresser eller datoer, hvilke intervaller tall kan ha, eller om en egenskap som forekommer én gang, også kan mangle. Legg til format, minimum, maxLength, enum eller pattern manuelt der du trenger det, og kontroller dataene mot resultatet med JSON Schema-validatoren.

Slik fungerer det

Verktøyet bruker genson-js, en JavaScript-portering av GenSON-schemabyggeren. Nøkkelordene det skriver, betyr det samme i Utkast 7 og Utkast 2020-12, så utkastet endrer bare $schema-linjen. Alt kjøres i nettleseren din: Eksempelet lastes aldri opp.

Funksjoner

  • JSON Schema fra et hvilket som helst JSON-eksempel
  • Typer, nøstede objekter og lister utledes automatisk
  • Listeelementer slås sammen til ett schema, og valgfrie egenskaper oppdages
  • Utkast 2020-12 eller Utkast 7
  • Påkrevde egenskaper kan slås av eller på
  • Kopier eller last ned som schema.json
  • Kjøres i nettleseren din