Einen JSON-Schema-Entwurf aus dokumentierten Feldern erstellen
Ein JSON-Schema-Entwurf macht die erwartete Datenstruktur ausdrücklich sichtbar. Er ist nützlich, wenn die Dokumentation Felder beschreibt, aber ein maschinenlesbarer Ausgangspunkt für die Validierung gebraucht wird.
Beginne mit dem richtigen Material.
- Was du bereitstellst
- eine sichtbare API-Antwortspezifikation.
- Das beabsichtigte Ergebnis
- Erstelle einen JSON-Schema-Entwurf, der dokumentierte Pflichtfelder beibehält und Annahmen markiert.
So funktioniert der Ablauf.
Ordne dokumentierte Felder Typen und Anforderungen zu und halte verschachtelte Objekte und Arrays klar erkennbar. Kennzeichne Annahmen zu Formaten, Einschränkungen und Schema-Dialekt, wenn die Quelle sie nicht vorgibt.
Was du am Ergebnis prüfen solltest.
Validiere das Schema und teste bekannte gültige und ungültige Beispiele. Markiere nicht jedes dokumentierte Feld als Pflichtfeld und erfinde keine restriktiven Regeln, nur weil dadurch ein ordentliches Schema entsteht.
Parse das JSON, bevor du es in einer anderen Anwendung verwendest, und prüfe danach die tatsächlichen Werte. Gültige Syntax zeigt nur, dass ein Parser die Struktur lesen kann; sie bestätigt nicht, dass die extrahierten Fakten stimmen.
Lerne am ausgearbeiteten Beispiel.
Das herunterladbare Beispiel ist ein JSON-Objekt. Vergleiche seine Struktur und den Umgang mit fehlenden Werten mit deinem gewünschten Ergebnis und prüfe deine Werte an der bereitgestellten Quelle.
Das bereitgestellte Beispiel dient zur Veranschaulichung. Es ist kein aufgezeichneter Durchlauf mit deinen Daten.
Beispiel herunterladen ↓Nutze es mit deinem eigenen Material.
- Öffne die gewünschte Quelle und aktiviere WebAct in diesem Tab.
- Kopiere die Aufgabe aus dem oberen Seitenbereich, ergänze nötige Felder oder Wünsche und prüfe die vorgeschlagenen Aktionen.
- Vergleiche das erste Ergebnis mit deiner Quelle. Bitte bei Bedarf um eine konkrete Korrektur oder Verfeinerung.