Zum Inhalt springen

JSON Schema Generator

Erzeuge aus einem JSON-Beispiel ein JSON-Schema. Der Generator leitet Typen, erforderliche Eigenschaften, Schemas für Array-Elemente und gängige String-Formate wie date-time, email, uri und uuid ab. Er erstellt ein Schema für Draft 2020-12, 2019-09 oder Draft-07, mit dem du Anfragen validieren, eine API dokumentieren oder Formulare generieren kannst.

Zurücksetzen

Häufig gestellte Fragen

Welche JSON-Schema-Drafts werden unterstützt?

Draft 2020-12, die aktuelle Version, die OpenAPI 3.1 verwendet, Draft 2019-09 und Draft-07, die von vielen älteren Validatoren und Werkzeugen weiterhin erwartet werden. Die Auswahl legt das $schema URL fest; die vom Generator geschriebenen Schlüsselwörter bedeuten in allen drei Versionen dasselbe.

Wie werden erforderliche Eigenschaften festgelegt?

Eine Eigenschaft wird unter required aufgeführt, wenn sie in jedem Beispiel dieses Objekts vorkommt. In einem Array mit Objekten wird ein Schlüssel, der in einigen Elementen fehlt, nicht unter required aufgeführt. Deaktiviere die Option, um ein Schema ohne required-Listen zu erstellen.

Welche String-Formate werden erkannt?

date-time, date, time, email, uri, uuid und ipv4. Ein Format wird nur hinzugefügt, wenn jeder Beispielwert dieser Eigenschaft dazu passt. Ein einzelner Freitextwert sorgt dafür, dass die Eigenschaft ein einfacher String bleibt. Deaktiviere die Erkennung, wenn du keine Format-Schlüsselwörter möchtest.

Unterscheidet das Schema Ganzzahlen von Dezimalzahlen?

Ja. Wenn alle Beispielwerte einer Eigenschaft Ganzzahlen sind, erhält sie den Typ integer. Sobald ein Beispielwert einen Nachkommateil hat, wird der Typ zu number, der auch Ganzzahlen akzeptiert.

Wie werden Arrays beschrieben?

Ein Array erhält den Typ array und ein items-Schema, das aus allen Elementen zusammen gebildet wird. Objekte in einem Array werden zusammengeführt. Daher führt das items-Schema jeden Schlüssel auf, der in irgendeinem Element vorkommt; required umfasst nur Schlüssel, die in allen Elementen vorkommen.

Was passiert bei gemischten Typen?

Enthält eine Eigenschaft einfache Werte unterschiedlicher Typen, etwa in einem Element einen String und in einem anderen null, führt das Schema sie als Typ-Array auf, zum Beispiel ["string", "null"]. Sind Objekte oder Arrays mit anderen Typen gemischt, verwendet der Generator anyOf mit jeweils einem Schema.

Fügt das Schema additionalProperties oder Beschränkungen hinzu?

Nein. An einem Beispiel lässt sich nicht erkennen, welche zusätzlichen Schlüssel verboten sind oder wie die tatsächlichen Mindest- und Höchstwerte lauten. Daher lässt der Generator additionalProperties, minLength, maximum und ähnliche Schlüsselwörter weg. Füge sie von Hand hinzu, wenn deine Daten sie erfordern.

Kann ich Daten mit dem Ergebnis validieren?

Ja. Füge das Schema und deine Daten in den JSON Schema Validator ein oder verwende eine Bibliothek wie Ajv. Überprüfe zuerst das Schema: Es bildet dein Beispiel ab. Wenn ein Feld in echten Daten fehlen oder null sein kann, im Beispiel aber nicht, musst du es geringfügig anpassen.

Kann ich das Schema in OpenAPI verwenden?

OpenAPI 3.1 verwendet JSON Schema 2020-12 direkt. Daher kannst du das generierte Schema nach dem Entfernen der Zeile $schema unter components/schemas einfügen. OpenAPI 3.0 verwendet eine ältere Teilmenge. Ersetze dort Typ-Arrays durch nullable.

Wie groß darf die Eingabe sein?

Bis zu 1,000,000 Zeichen aus JSON, verschachtelt bis zu 64 Ebenen. Das Beispiel wird nur für diese Anfrage analysiert und nicht gespeichert.

Über OneClick Pro

OneClick Pro ist eine kostenlose Sammlung mit mehr als 150 Webtools für die tägliche Arbeit: Bilder und Einheiten umwandeln, Code formatieren und validieren, Domains und SEO überprüfen sowie mit Texten, Terminen und Zahlen arbeiten. Jedes Tool funktioniert ohne Registrierung oder Abo. Deine Eingaben werden nur zur Berechnung des Ergebnisses verwendet und niemals gespeichert. Nutze die Sammlung als praktischen Werkzeugkasten für einzelne Aufgaben oder setze ein Lesezeichen für die Tools, die du täglich brauchst.