Nutzen Sie JSON Schema, um API-Verträge zu dokumentieren, JSON-Payloads zu validieren und realistische Mock-Daten für Tests und Demos zu generieren.
Schritt 1 – Mit einem realen Beispiel starten
- Fügen Sie eine echte API-Antwort, ein Request-Payload oder Konfig-JSON zuerst in den Formatter ein.
- Pflegen Sie pro Endpoint ein kanonisches JSON-Beispiel, um Schema-Drift zu vermeiden.
Schritt 2 – Basis-Schema generieren
- Nutzen Sie den Schema-Generator, um Typen, Pflichtfelder und verschachtelte Strukturen zu inferieren.
- Verfeinern Sie Beschreibungen, Formate und Constraints (min/max, patterns) für den Produktionseinsatz.
Schritt 3 – JSON gegen das Schema validieren
- Fügen Sie Schema und echte Payloads in den Schema-Validator ein.
- Beheben Sie Fehler, indem Sie entweder das JSON (Bug) oder das Schema (Vertragsänderung) anpassen.
Schritt 4 – Mock-Daten für Tests erzeugen
- Öffnen Sie den Mock-Generator, um realistische Beispiel-Payloads passend zum Schema zu erstellen.
- Nutzen Sie Seed + Batch-Größe, um Testdaten reproduzierbar und skalierbar zu machen.
Schritt 5 – Teilen und wiederverwenden
- Speichern Sie Schemas in der Versionskontrolle und verlinken Sie sie in Ihrer API-Doku.
- Generieren Sie typisierten Code (TypeScript/Java/etc.) aus stabilen JSON-Beispielen.
Wichtiger Hinweis zu JSON-Schema-Features
- Einige Schemas verwenden fortgeschrittene Keywords wie
$ref, anyOf, oneOf, und allOf. - Validatoren unterstützen Drafts und Keywords unterschiedlich gut; für strikte Compliance sollten Sie in CI einen vollständigen JSON-Schema-Validator einsetzen.
Beispiel: JSON → JSON Schema (vereinfacht)
// JSON input
{
"id": 1,
"name": "Maeve Winters",
"active": true,
"tags": ["developer", "backend"]
}
// Generated schema (example)
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"active": { "type": "boolean" },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "name", "active", "tags"]
}