Wat doet de JSON Schema-generator?

Deze maakt een JSON Schema voor je op basis van een voorbeeld van je gegevens. Plak een voorbeeld, zoals een API-respons, een configuratiebestand of een record uit een database-export, en je krijgt een schema dat de structuur beschrijft: het type van elke waarde, de eigenschappen van elk object, hoe de items van elke array eruitzien en welke eigenschappen verplicht zijn. Het is een snelle start voor API-documentatie, OpenAPI-specificaties, formuliervalidatie of gegevenscontracten, die je daarna handmatig verder kunt aanscherpen.

Zo gebruik je de tool

  1. Plak of typ voorbeeld-JSON in het invoerveld.
  2. Kies de JSON Schema-versie voor de regel $schema: Draft 2020-12 of Draft 7.
  3. Kies of eigenschappen als verplicht moeten worden gemarkeerd.
  4. Kopieer het schema of download het als schema.json.

Als het voorbeeld geen geldige JSON is, geeft de tool de regel en kolom van het probleem aan en markeert die.

Hoe het schema wordt bepaald

  • Elke waarde krijgt het bijbehorende JSON-type: string, boolean, null, object, array en integer voor gehele getallen of number voor getallen met decimalen. Een array met gehele getallen en kommagetallen krijgt het type number, dat beide omvat.
  • Voor elk object wordt voor elke sleutel een properties-vermelding gemaakt, op dezelfde manier beschreven en zo diep als het voorbeeld gaat.
  • Voor arrays wordt één items-schema gemaakt dat op elk item van toepassing is. Als de items objecten zijn, worden hun eigenschappen samengevoegd, zodat een lijst met records één schema voor een record oplevert.
  • Waarden met gemengde typen krijgen alle typen in een lijst, zoals ["string", "null"], of een anyOf wanneer objecten en andere waarden door elkaar voorkomen.
  • Een lege array krijgt "type": "array" zonder items, omdat er niets te beschrijven valt.

Verplichte eigenschappen

Als ‘Eigenschappen als verplicht markeren’ is ingeschakeld, worden de sleutels van elk object onder required vermeld. Bij een array met objecten is een eigenschap alleen verplicht als elk item die heeft: in een lijst met leden waarin slechts sommigen een favorite hebben, is die eigenschap optioneel. Schakel de optie uit om een schema zonder required-lijsten te krijgen.

Wat je niet uit een voorbeeld kunt afleiden

Een schema dat op basis van één voorbeeld is gemaakt, weet alleen wat dat voorbeeld laat zien. Het kan niet weten welke stringwaarden e-mailadressen of datums zijn, welke bereiken getallen kunnen hebben, of dat een eigenschap die één keer voorkomt ook kan ontbreken. Voeg waar nodig handmatig format, minimum, maxLength, enum of pattern toe en controleer gegevens aan de hand van het resultaat met de JSON Schema-validator.

Hoe het werkt

De tool gebruikt genson-js, een JavaScript-port van de GenSON-schemabouwer. De gebruikte trefwoorden betekenen hetzelfde in Draft 7 en Draft 2020-12; alleen de regel $schema verschilt per versie. Alles wordt in je browser uitgevoerd: het voorbeeld wordt nooit geüpload.

Functies

  • JSON Schema op basis van elk JSON-voorbeeld
  • Typen, geneste objecten en arrays automatisch bepaald
  • Array-items samengevoegd in één schema, met gevonden optionele eigenschappen
  • Draft 2020-12 of Draft 7
  • Verplichte eigenschappen in- of uitschakelen
  • Kopiëren of downloaden als schema.json
  • Werkt in je browser