JSON Schema Generator

Wat de JSON Schema Generator doet

De JSON Schema Generator leest een JSON-voorbeeld en maakt een draft-07-schema dat documenten met dezelfde structuur valideert. Hij loopt recursief door de waarde: objecten worden een schema met een properties-map en een required-array, arrays worden een schema met een items-definitie en primitieve waarden worden beschreven met hun JSON Schema-type. Het resultaat is een overdraagbaar contract dat je kunt gebruiken in API-documentatie, validatie-middleware voor verzoeken, configuratieladers, contracttests of editortools die automatisch aanvullen en inline valideren op basis van een schema.

Arrays worden samengevat in plaats van opgesomd. Als een array objecten bevat, worden alle elementen samengevoegd zodat het gegenereerde items-schema de unie van alle sleutels dekt, en een sleutel die in sommige elementen ontbreekt, wordt uit de lijst met verplichte velden gehaald. Als een array primitieve typen mengt, maakt de generator een anyOf zodat elk waargenomen type geldig blijft. Genereren vanuit een voorbeeld is de snelste manier om een schema op te zetten dat je daarna met de hand verfijnt, in plaats van geneste typedefinities helemaal zelf te schrijven.

Privé werken in de browser

Alle parsing en schema-opbouw gebeurt in je browser met JavaScript aan de clientzijde. De tool uploadt je JSON, API-antwoorden, configuratie, identificatoren of op klantdata lijkende voorbeelden niet naar een server en vereist geen account. Dat uitsluitend lokale gedrag is belangrijk, omdat de invoer van een schemagenerator vaak een echte payload is die tijdens het debuggen van een service is vastgelegd. Door het werk op je eigen computer te houden verklein je risico's en is het resultaat direct beschikbaar, omdat er niets de pagina verlaat.

De interface toont de JSON-invoer en het gegenereerde schema naast elkaar, zodat je de uitvoer kunt controleren voordat je kopieert. Een schema dat uit één voorbeeld is gegenereerd, is een startpunt en geen afgerond contract: één voorbeeld kan niet elke optionele eigenschap, enum-waarde, formatbeperking of numeriek bereik van jouw domein onthullen. Verbreed en verscherp het schema dus met kennis die het voorbeeld niet bevat.

Praktische tips

Gebruik het meest complete voorbeeld dat je hebt, inclusief ingevulde optionele velden en arrays met meer dan één element, zodat de samenvoeglogica unies nauwkeurig kan beschrijven. Verfijn het schema na het genereren: voeg waar nodig format-trefwoorden toe zoals email, uri of date-time, voeg enum-lijsten toe voor velden met een vaste set waarden, stel minimum en maximum in voor getallen en haal velden die legitiem kunnen ontbreken uit de required-array. Valideer het uiteindelijke schema met meerdere echte documenten en een validator naar keuze voordat je het in productie gebruikt; genereren in de browser is het best geschikt voor een snelle, nauwkeurige eerste versie.