Startseite › Entwickler-Tools › JSON Schema Generator

JSON Schema Generator

Füge ein Beispiel-JSON-Dokument ein und erhalte sofort ein einsatzbereites JSON Schema. Typen, verschachtelte Objekte, Array-Einträge, Pflichtfelder und String-Formate wie email, date-time und uri werden für dich abgeleitet, und nichts verlässt deinen Browser.

Zuletzt aktualisiert:

Feldübersicht
PfadTypFormatPflicht
Anzeige
Anzeige

Anleitung: JSON Schema Generator

  1. Füge Beispiel-JSON in den linken Editor ein, lade eine .json-Datei hoch oder lade das Beispiel. Verwende echte Daten mit allen Feldern, die du erwartest.
  2. Wähle den Draft (2020-12 ist die aktuelle Version) und wie Pflichtfelder bestimmt werden sollen.
  3. Schalte die Optionen um: Formaterkennung, Beispiele, Min/Max-Einschränkungen und striktes additionalProperties.
  4. Prüfe das Schema rechts und die Feldübersicht darunter. Es wird beim Tippen aktualisiert.
  5. Kopiere oder lade das Schema als schema.json herunter und verfeinere Titel, Beschreibungen oder Enums von Hand.

So werden JSON-Werte auf Schema-Typen abgebildet

BeispielwertGeneriertes SchemaHinweise
"Ann"{"type": "string"}Plus format, wenn jeder Wert einem Format entspricht
42{"type": "integer"}Nur ganze Zahlen
4.5{"type": "number"}Wird verwendet, wenn ein Wert einen Nachkommaanteil hat
true{"type": "boolean"}
null{"type": "null"}Kombiniert: ["string", "null"]
{"a": 1}{"type": "object", "properties": {…}, "required": […]}Verschachtelte Objekte werden rekursiv beschrieben
[1, 2]{"type": "array", "items": {"type": "integer"}}Alle Einträge werden zu einem items-Schema zusammengeführt

Erkannte String-Formate

formatBeispielStandard
date-time2024-05-01T09:30:00Z, 2024-05-01T09:30:00.5+02:00RFC 3339 Datum-Uhrzeit (Offset erforderlich)
date2024-05-01RFC 3339 vollständiges Datum
time09:30:00ZRFC 3339 vollständige Uhrzeit
email[email protected]RFC 5321 Postfach
urihttps://example.com/a?b=1RFC 3986 absoluter URI
uuidb3f1c2d4-5e6f-4a1b-9c8d-7e6f5a4b3c2dRFC 4122
ipv4 / ipv6192.168.0.1, 2001:db8::1RFC 2673 bzw. RFC 4291

Ein Wert wie 2024-05-01 09:30 (Leerzeichen statt T, ohne Sekunden oder Offset) ist keine gültige RFC-3339-Datum-Uhrzeit und bleibt daher ein einfacher String. In Draft 2020-12 ist format standardmäßig eine Annotation: Validatoren wie Ajv setzen es nur durch, wenn die Format-Validierung aktiviert ist (zum Beispiel mit dem Plugin ajv-formats).

Tipps für ein besseres generiertes Schema

  • Gib ihm mehrere Beispiele. Füge ein Array echter Datensätze statt eines einzelnen Objekts ein. Felder, die in manchen Datensätzen fehlen, werden optional, und nullbare Felder erhalten "null" in ihrem Typ.
  • Bearbeite es vor der Veröffentlichung. Das Ableiten kann keine Geschäftsregeln kennen. Ergänze enum für feste Wertelisten, pattern für IDs und description für die Dokumentation, und erweitere Min/Max-Grenzen, die aus einem kleinen Beispiel stammen.
  • Strikte Objekte. "additionalProperties": false lehnt jede nicht aufgeführte Eigenschaft ab. Das ist nützlich für API-Request-Bodys, lässt das Schema aber jedes Mal scheitern, wenn ein neues Feld hinzukommt.
  • Validiere es. Teste das Schema mit einem Validator gegen dein Beispiel und einige fehlerhafte Datensätze, bevor du dich darauf verlässt.

Häufige Fragen

Was ist ein JSON Schema?

JSON Schema ist ein Vokabular zur Beschreibung der Struktur von JSON-Daten: welche Eigenschaften ein Objekt hat, welche Typen sie haben, welche davon Pflicht sind und welche Werte erlaubt sind. Validatoren wie Ajv prüfen mit einem Schema, ob eingehendes JSON korrekt ist.

Welchen JSON-Schema-Draft sollte ich wählen?

Wähle Draft 2020-12, außer ein Tool, das du nutzt, verlangt eine ältere Version. Es ist die neueste veröffentlichte Version und wird von OpenAPI 3.1 verwendet. Draft-07 ist in älteren Validatoren und Editoren noch verbreitet. Für die Schlüsselwörter, die dieser Generator ausgibt, unterscheiden sich die Drafts nur in der $schema-URI.

Wie werden Pflichtfelder bestimmt?

Mit der Standardeinstellung ist eine Eigenschaft nur dann Pflicht, wenn sie in jedem Objekt dieser Struktur in deinem Beispiel vorkommt. Fügst du ein Array mit 10 Nutzern ein und nur 7 haben ein Feld phone, ist phone optional. Du kannst auch alle oder keine Felder als Pflicht markieren.

Wie funktioniert die Formaterkennung?

Ein String erhält ein Format wie email, date-time, date, time, uri, uuid, ipv4 oder ipv6 nur dann, wenn jeder Beispielwert dieses Felds dem Muster entspricht. date-time folgt RFC 3339, zum Beispiel 2024-05-01T09:30:00Z. Beachte, dass Validatoren format als Annotation behandeln, solange die Format-Prüfung nicht eingeschaltet ist.

Warum ist ein Feld als integer und nicht als number typisiert?

Der Typ integer in JSON Schema passt auf jede Zahl ohne Nachkommaanteil. Sind alle Beispielwerte ganze Zahlen, verwendet der Generator integer; hat irgendein Wert einen Nachkommaanteil, wird das Feld zu number, das auch ganze Zahlen akzeptiert.

Was passiert mit null-Werten oder gemischten Typen?

Ein Feld, das mal ein String und mal null ist, bekommt "type": ["string", "null"]. Gemischte komplexe Typen, etwa ein Objekt in einem Eintrag und ein Array in einem anderen, werden mit anyOf kombiniert.

Wird mein JSON irgendwohin hochgeladen?

Nein. Parsen und Ableiten des Schemas laufen komplett per JavaScript in deinem Browser, private API-Antworten und Datendateien bleiben also auf deinem Gerät.

Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?

Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.

Ähnliche Tools

Alle Code-Generatoren & Builder ansehen →