Was macht der JSON-Schema-Generator?

Er erstellt aus einem Beispiel Ihrer Daten ein JSON Schema. Fügen Sie ein Beispiel ein, etwa eine API-Antwort, eine Konfigurationsdatei oder einen Datensatz aus einem Datenbankexport. Sie erhalten ein Schema, das die Struktur beschreibt: den Typ jedes Werts, die Eigenschaften jedes Objekts, den Aufbau der Elemente jedes Arrays und die erforderlichen Eigenschaften. Damit können Sie schnell mit der API-Dokumentation, OpenAPI-Spezifikationen, der Formularvalidierung oder Datenverträgen loslegen und das Schema anschließend manuell verfeinern.

So verwenden Sie das Tool

  1. Fügen Sie Beispiel-JSON in das Eingabefeld ein oder geben Sie es dort ein.
  2. Wählen Sie den JSON-Schema-Entwurf für die Zeile $schema: Draft 2020-12 oder Draft 7.
  3. Legen Sie fest, ob Eigenschaften als erforderlich markiert werden sollen.
  4. Kopieren Sie das Schema oder laden Sie es als schema.json herunter.

Wenn das Beispiel kein gültiges JSON ist, zeigt das Tool die Zeile und Spalte des Problems an und markiert die betreffende Stelle.

So wird das Schema ermittelt

  • Jeder Wert erhält seinen JSON-Typ: string, boolean, null, object, array und integer für ganze Zahlen oder number für Dezimalzahlen. Ein Array mit ganzen Zahlen und Dezimalzahlen erhält den Typ number, der beides abdeckt.
  • Für jedes Objekt wird für jeden Schlüssel ein Eintrag unter properties angelegt und auf dieselbe Weise beschrieben – so tief, wie es das Beispiel vorgibt.
  • Für Arrays wird ein einzelnes items-Schema erstellt, das zu allen Elementen passt. Bei Objekten werden ihre Eigenschaften zusammengeführt, sodass eine Liste von Datensätzen ein gemeinsames Schema für einen Datensatz ergibt.
  • Bei Werten mit unterschiedlichen Typen werden alle Typen in einer Liste aufgeführt, etwa ["string", "null"]. Wenn Objekte und andere Werte gemischt vorkommen, wird stattdessen anyOf verwendet.
  • Für ein leeres Array wird "type": "array" ohne items ausgegeben, da es keine Elemente zu beschreiben gibt.

Erforderliche Eigenschaften

Ist „Eigenschaften als erforderlich markieren“ aktiviert, werden die Schlüssel jedes Objekts unter required aufgeführt. Bei einem Array aus Objekten ist eine Eigenschaft nur dann erforderlich, wenn sie in jedem Element vorkommt: In einer Liste von Mitgliedern, bei denen nur manche eine favorite-Eigenschaft haben, ist diese Eigenschaft optional. Deaktivieren Sie die Option, wenn Sie ein Schema ohne required-Listen erhalten möchten.

Was sich aus einem Beispiel nicht ableiten lässt

Ein Schema, das aus einem einzigen Beispiel erstellt wird, kennt nur die darin gezeigten Informationen. Es kann nicht erkennen, welche Zeichenfolgen E-Mail-Adressen oder Datumsangaben sind, welche Wertebereiche Zahlen annehmen können oder ob eine einmal vorhandene Eigenschaft auch fehlen kann. Fügen Sie bei Bedarf manuell format, minimum, maxLength, enum oder pattern hinzu und prüfen Sie die Daten anschließend mit dem JSON-Schema-Validator.

Funktionsweise

Das Tool verwendet genson-js, eine JavaScript-Portierung des GenSON-Schema-Generators. Die von ihm ausgegebenen Schlüsselwörter haben in Draft 7 und Draft 2020-12 dieselbe Bedeutung. Der Entwurf ändert daher nur die Zeile $schema. Alles läuft in Ihrem Browser: Das Beispiel wird niemals hochgeladen.

Funktionen

  • JSON Schema aus beliebigem Beispiel-JSON erstellen
  • Typen, verschachtelte Objekte und Arrays automatisch ermitteln
  • Array-Elemente zu einem Schema zusammenführen und optionale Eigenschaften erkennen
  • Draft 2020-12 oder Draft 7
  • Erforderliche Eigenschaften ein- oder ausschalten
  • Als schema.json kopieren oder herunterladen
  • Läuft in Ihrem Browser