So verwenden Sie JSON zu JSON Schema
- Fügen Sie ein repräsentatives JSON-Beispiel ein, idealerweise eines, in dem alle optionalen Felder gefüllt sind.
- Legen Sie den Namen des Wurzeltyps fest und entscheiden Sie, ob Sie auch Hilfscode oder nur Typen haben möchten.
- Kopieren Sie den erzeugten JSON-Schema-Code in Ihr Projekt.
Über JSON zu JSON Schema
Modellklassen für eine große JSON-Payload von Hand zu schreiben, ist öde, und genau dort schleichen sich Tippfehler ein. Fügen Sie hier ein Beispiel ein, und der Generator ermittelt die Struktur: welche Felder es gibt, welche Objekte, welche Arrays sind und welchen Typ jeder Wert hat. Die Ausgabe ist ein JSON-Schema-Dokument (Draft-06-Variante), das die Struktur beschreibt.
Es wird aus einem einzigen Beispiel abgeleitet und beschreibt daher dieses Beispiel. Prüfen Sie es, bevor Sie es zur Validierung von Produktivdaten verwenden, zum Beispiel um String-Formate zu verschärfen oder Grenzwerte hinzuzufügen. Alles läuft in Ihrem Browser, sodass Ihre Beispieldaten auf Ihrem Rechner bleiben.
Den erzeugten Code verwenden
Speichern Sie die Ausgabe als .json-Datei und verwenden Sie sie mit einem Validator wie Ajv oder jsonschema, um andere Dokumente zu prüfen.
Felder, die nicht in jedem Beispieldatensatz vorkommen, werden aus der Liste der Pflichtfelder (required) ausgelassen.