JSON-Schema-Generator

Was der JSON-Schema-Generator macht

Der JSON-Schema-Generator liest ein JSON-Beispiel und erzeugt ein draft-07-Schema, das Dokumente mit derselben Struktur validiert. Er durchläuft den Wert rekursiv: Objekte werden zu einem Schema mit einer properties-Map und einem required-Array, Arrays werden zu einem Schema mit einer items-Definition, und primitive Werte werden mit ihrem JSON-Schema-type beschrieben. Das Ergebnis ist ein portabler Vertrag, den Sie in API-Dokumentationen, Validierungs-Middleware für Anfragen, Konfigurationslader, Vertragstests oder Editor-Werkzeuge einbinden können, die auf Basis eines Schemas Autovervollständigung und Inline-Validierung bieten.

Arrays werden zusammengefasst statt aufgezählt. Enthält ein Array Objekte, werden alle Elemente zusammengeführt, sodass das erzeugte items-Schema die Vereinigung aller Schlüssel abdeckt; ein Schlüssel, der in einigen Elementen fehlt, wird aus der Liste der Pflichtfelder entfernt. Mischt ein Array primitive Typen, erzeugt der Generator ein anyOf, damit jeder beobachtete Typ gültig bleibt. Die Generierung aus einem Beispiel ist der schnellste Weg, ein Schema anzulegen, das Sie anschließend von Hand verfeinern, statt verschachtelte Typdefinitionen von Grund auf zu schreiben.

Privater Workflow im Browser

Das gesamte Parsen und der Aufbau des Schemas laufen in Ihrem Browser mit clientseitigem JavaScript ab. Das Tool lädt Ihr JSON, API-Antworten, Konfigurationen, Kennungen oder kundennahe Beispiele nicht auf einen Server hoch und erfordert kein Konto. Dieses rein lokale Verhalten ist wichtig, weil die Eingabe eines Schema-Generators oft eine echte Nutzlast ist, die beim Debuggen eines Dienstes erfasst wurde. Die Arbeit auf Ihrem Rechner zu behalten verringert Risiken und liefert das Ergebnis sofort, da nichts die Seite verlässt.

Die Oberfläche zeigt die JSON-Eingabe und das erzeugte Schema nebeneinander, sodass Sie das Ergebnis vor dem Kopieren prüfen können. Ein aus einem Beispiel erzeugtes Schema ist ein Ausgangspunkt und kein fertiger Vertrag: Ein einzelnes Beispiel kann nicht jede optionale Eigenschaft, jeden Enum-Wert, jede Formateinschränkung oder jeden Zahlenbereich Ihrer Domäne offenlegen. Erweitern und verschärfen Sie das Schema daher mit Wissen, das im Beispiel nicht enthalten ist.

Praktische Tipps

Verwenden Sie das vollständigste verfügbare Beispiel, einschließlich befüllter optionaler Felder und Arrays mit mehr als einem Element, damit die Zusammenführungslogik Vereinigungen korrekt beschreiben kann. Verfeinern Sie das Schema nach der Generierung: Ergänzen Sie format-Schlüsselwörter wie email, uri oder date-time, wo sinnvoll, fügen Sie enum-Listen für Felder mit festem Wertebereich hinzu, setzen Sie minimum und maximum bei Zahlen und entfernen Sie aus dem required-Array Felder, die legitim fehlen dürfen. Validieren Sie das fertige Schema mit mehreren echten Dokumenten und einem Validator Ihrer Wahl, bevor Sie es produktiv einsetzen – die Generierung im Browser eignet sich am besten für einen schnellen, genauen ersten Entwurf.