Wichtige Fakten
- Kategorie
- Development
- Eingabetypen
- textarea, select, checkbox
- Ausgabetyp
- json
- Sample-Abdeckung
- 4
- API verfügbar
- Yes
Überblick
Der JSON-Schema-Generator ermöglicht es Entwicklern, aus einem vorhandenen JSON-Beispiel präzise JSON-Schemas abzuleiten, diese manuell anzupassen und direkt gegen das Datenmodell zu validieren.
Wann verwenden
- •Bei der Erstellung von API-Dokumentationen basierend auf vorhandenen Beispiel-Payloads.
- •Zur schnellen Definition von Datenstrukturen für neue Microservices oder Daten-Pipelines.
- •Wenn bestehende JSON-Daten auf Konformität mit einem definierten Schema geprüft werden müssen.
So funktioniert es
- •Fügen Sie Ihr Beispiel-JSON in das Eingabefeld ein.
- •Wählen Sie die gewünschte Schema-Version (z. B. 2020-12) und aktivieren Sie Optionen wie die Formaterkennung.
- •Das Tool generiert automatisch ein valides JSON-Schema, das Sie bei Bedarf manuell verfeinern können.
- •Nutzen Sie die integrierte Validierungsfunktion, um sicherzustellen, dass Ihr angepasstes Schema korrekt mit dem Beispiel harmoniert.
Anwendungsfälle
Beispiele
1. API-Payload Dokumentation
Backend-Entwickler- Hintergrund
- Ein Entwickler muss für einen neuen Endpunkt eine Dokumentation erstellen, hat aber nur ein Beispiel-JSON der Antwort.
- Problem
- Manuelle Erstellung des Schemas ist fehleranfällig und zeitaufwendig.
- Verwendung
- Beispiel-JSON einfügen, 'Gängige Formate erkennen' aktivieren und das generierte Schema als Basis für die API-Dokumentation kopieren.
- Ergebnis
- Ein präzises, validiertes JSON-Schema, das direkt in die API-Spezifikation übernommen werden kann.
2. Datenvalidierung für Microservices
Data Engineer- Hintergrund
- Daten fließen zwischen verschiedenen Diensten und müssen strikt validiert werden.
- Problem
- Unklare Datenstrukturen führen zu Laufzeitfehlern in den nachgelagerten Diensten.
- Verwendung
- JSON-Beispiel hochladen, Schema generieren, manuell um 'required'-Felder ergänzen und die Validierung gegen das Beispiel ausführen.
- Ergebnis
- Ein robustes Schema, das als Validierungs-Layer für eingehende API-Anfragen dient.
Mit Samples testen
jsonVerwandte Hubs
FAQ
Welche JSON-Schema-Versionen werden unterstützt?
Das Tool unterstützt aktuell die Versionen 2020-12 sowie Draft-07.
Kann ich das generierte Schema manuell bearbeiten?
Ja, Sie können das Schema im Feld 'Angepasstes Schema-JSON' bearbeiten und anschließend gegen das Beispiel validieren.
Was bewirkt die Option 'Enum aus Arrays ableiten'?
Wenn diese Option aktiviert ist, erkennt das Tool wiederkehrende Werte in Arrays und erstellt daraus ein Enum-Feld im Schema.
Werden Datumsformate oder E-Mails automatisch erkannt?
Ja, bei aktivierter Option 'Gängige Formate erkennen' werden Felder wie E-Mail-Adressen oder Datumsangaben automatisch mit entsprechenden 'format'-Attributen versehen.
Ist die Validierung verpflichtend?
Nein, die Validierung ist optional, hilft aber dabei, Fehler in der Schema-Definition frühzeitig zu erkennen.