Ga naar de inhoud

JSON Schema Generator

Genereer een JSON-schema op basis van voorbeeld-JSON. De generator leidt types, verplichte eigenschappen, schema's voor array-items en gangbare tekenreeksformaten zoals date-time, email, uri en uuid af. Ook maakt deze een schema voor draft 2020-12, 2019-09 of draft-07 dat u kunt gebruiken om requests te valideren, een API te documenteren of formulieren te genereren.

Resetten

Veelgestelde vragen

Welke JSON Schema-drafts worden ondersteund?

Draft 2020-12, de huidige versie die OpenAPI 3.1 gebruikt, draft 2019-09 en draft-07, waarop veel oudere validators en tools nog steeds rekenen. De keuze bepaalt de $schema-URL; de trefwoorden die de generator schrijft, betekenen in alle drie hetzelfde.

Hoe worden verplichte eigenschappen bepaald?

Een eigenschap wordt onder required vermeld als deze in elk voorbeeld van dat object voorkomt. In een array met objecten wordt een sleutel die in sommige items ontbreekt, niet opgenomen in required. Schakel de optie uit om een schema zonder required-lijsten te maken.

Welke tekenreeksformaten worden herkend?

date-time, date, time, email, uri, uuid en ipv4. Een formaat wordt alleen toegevoegd als elke voorbeeldwaarde van die eigenschap ermee overeenkomt. Eén vrije-tekstwaarde houdt de eigenschap dus een gewone string. Schakel herkenning uit als u geen format-trefwoorden wilt.

Maakt het schema onderscheid tussen gehele getallen en decimalen?

Ja. Een eigenschap waarvan de voorbeeldwaarden allemaal gehele getallen zijn, krijgt het type integer. Zodra één voorbeeld een decimaal deel heeft, wordt het type number; dat accepteert ook gehele getallen.

Hoe worden arrays beschreven?

Een array krijgt het type array en een items-schema dat is opgebouwd uit alle elementen samen. Objecten in een array worden samengevoegd, zodat het items-schema elke sleutel bevat die in een element voorkomt. Alleen sleutels die in alle elementen voorkomen, worden als required opgenomen.

Wat gebeurt er bij gemengde types?

Als een eigenschap eenvoudige waarden van verschillende types bevat, bijvoorbeeld een string in het ene item en null in een ander, vermeldt het schema deze als een type-array, bijvoorbeeld ["string", "null"]. Als objecten of arrays met andere types worden gemengd, gebruikt de generator anyOf met voor elk type een schema.

Voegt de generator additionalProperties of limieten toe?

Nee. Een voorbeeld laat niet zien welke extra sleutels verboden zijn of wat de echte minimum- en maximumwaarden zijn. Daarom laat de generator additionalProperties, minLength, maximum en vergelijkbare trefwoorden weg. Voeg ze handmatig toe als uw gegevens dat vereisen.

Kan ik gegevens valideren met het resultaat?

Ja. Plak het schema en uw gegevens in de JSON Schema Validator of gebruik het met een bibliotheek zoals Ajv. Controleer het schema eerst: het is gebaseerd op uw voorbeeld. Een veld dat in echte gegevens kan ontbreken of null kan zijn, maar dat niet in het voorbeeld is, moet u dus aanpassen.

Kan ik het schema in OpenAPI gebruiken?

OpenAPI 3.1 gebruikt JSON Schema 2020-12 rechtstreeks, zodat het gegenereerde schema onder components/schemas kan worden geplaatst nadat u de regel $schema hebt verwijderd. OpenAPI 3.0 gebruikt een oudere subset; vervang daar type-arrays door nullable.

Hoe groot mag de invoer zijn?

Maximaal 1,000,000 tekens van JSON, genest tot 64 niveaus diep. Het voorbeeld wordt alleen voor dit verzoek geanalyseerd en niet opgeslagen.

Over OneClick Pro

OneClick Pro is een gratis verzameling van meer dan 150 webtools voor dagelijks werk: afbeeldingen en eenheden converteren, code opmaken en valideren, domeinen en SEO controleren, en werken met tekst, datums en getallen. Elke tool werkt zonder registratie of abonnement. Wat u invoert, wordt alleen gebruikt om uw resultaat te berekenen en wordt nooit opgeslagen. Gebruik de verzameling als snelle gereedschapskist voor eenmalige taken of maak een bladwijzer van de tools die u dagelijks gebruikt.