Wie Sie JSON Schema zur Validierung Ihrer Daten verwenden
Was ist ein JSON Schema?
Ein JSON Schema ist eine standardisierte Methode, um die Struktur, erforderliche Felder und Datentypen Ihrer JSON-Daten zu beschreiben. Man kann es sich wie einen Vertrag oder Bauplan vorstellen, der definiert, wie gültiges JSON aussehen soll. JSON Schema wird selbst in JSON geschrieben, was es sowohl maschinenlesbar als auch einfach zu bearbeiten macht.
Warum mit einem Schema validieren?
- Fehler verhindern, indem ungültige oder fehlende Daten erkannt werden, bevor sie Probleme verursachen.
- Datenkonsistenz über verschiedene Teams, Anwendungen oder APIs hinweg sicherstellen.
- Automatisch Dokumentation aus Schemas generieren.
- Editoren und Tools ermöglichen so bessere Autovervollständigung und kontextspezifische Hilfen.
Ein einfaches Beispiel: Grundschema
Hier sehen Sie ein einfaches JSON-Objekt, gefolgt von einem minimalen Schema, das dessen Struktur validiert:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Dieses Schema stellt sicher, dass das Objekt ein 'name' (als Zeichenkette) und ein 'age' (als Zahl) enthalten muss.
So erstellen Sie ein benutzerdefiniertes Schema
Sie können in Ihrem Schema komplexe Regeln definieren: Werte einschränken, verschachtelte Objekte angeben oder Mindest- und Höchstwerte festlegen. Hier ein Beispiel zur Validierung eines Produkt-Arrays:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Verwendung von JSONValidator.dev zur Schema-Validierung
- Fügen Sie Ihre JSON-Daten im Haupteditor ein.
- Fügen Sie Ihr JSON Schema im darunterliegenden Schema-Editor ein.
- Klicken Sie auf JSON gegen dieses Schema validieren.
- Überprüfen Sie die Validierungsergebnisse – alle Fehler werden hervorgehoben und erläutert.
Fehlerbehebung bei Schema-Validierungsfehlern
Häufige Ursachen für Validierungsfehler sind:
- Ein erforderliches Feld fehlt in Ihren Daten.
- Ein Wert hat nicht den im Schema definierten Typ (z. B. Zeichenkette statt Zahl).
- Das Schema selbst ist ungültig oder enthält Tippfehler.
Fazit
Die Validierung mit JSON Schema ist ein wirkungsvolles Mittel, um Ihre Daten robust und fehlerfrei zu machen. Probieren Sie aus, mit unserem kostenlosen JSON Schema Generator ein Schema für Ihre Daten zu erstellen und live zu validieren!