JSON-zu-JSON-Schema
Generieren Sie ein JSON-Schema aus Beispiel-JSON – Validierungsregeln, abgeleitet.
So verwenden Sie JSON-zu-JSON-Schema
- Fügen Sie ein repräsentatives JSON-Beispiel ein – vollständig ausgefüllt schlägt spärlich; Echte API-Antworten funktionieren gut.
- Lesen Sie das abgeleitete Schema – Typen und Strukturen werden automatisch transkribiert.
- Verfeinern Sie den Vertrag: Legen Sie erforderliche Felder fest, fügen Sie Wertbeschränkungen hinzu, entscheiden Sie über zusätzliche Eigenschaften.
- Bereitstellen – API-Validierungs-Middleware, OpenAPI-Spezifikation oder „$schema“-Referenz für Editor-Tools.
Was ist JSON-zu-JSON-Schema?
Ein JSON-zu-Schema-Generator liest ein Beispieldokument und leitet das JSON-Schema ab, das es beschreibt: den Typ jedes Felds (Zeichenfolge, Zahl, Boolescher Wert, Array, Objekt), die Verschachtelungsstruktur und das Grundgerüst eines Validierungsvertrags. Füttere es mit einer echten API-Nutzlast und erhalte das Schema, das so geformte Nutzlasten validieren würde.
Das JSON-Schema ist der Standard für die Aussage „Daten müssen so aussehen“ – API-Anforderungs-/Antwortvalidierung, Konfigurationsdateiprüfung, Formulargenerierung und Codegenerierung werden alle darauf ausgeführt. Das manuelle Schreiben von Schemata für eine bestehende Struktur ist eine mühsame Transkription. Wenn Sie aus einem Beispiel schließen, übernehmen Sie die Transkription und überlassen Ihnen die Urteilsfindung.
Über den JSON-zu-JSON-Schema
Fügen Sie ein repräsentatives JSON-Beispiel ein und erhalten Sie das abgeleitete Schema – Typen, Eigenschaften und Struktur zugeordnet, bereit zur Verfeinerung.
Die Verfeinerung, die den Rückschluss in einen Vertrag umwandelt: Markieren Sie, welche Eigenschaften erforderlich sind (der Rückschluss kann die Absicht nicht kennen – er sah sie vorhanden, nicht obligatorisch), fügen Sie Einschränkungen hinzu, die das Beispiel nicht ausdrücken kann (Minimum/Maximum für Zahlen, minLength/Muster für Zeichenfolgen, Aufzählung für geschlossene Wertemengen) und entscheiden Sie additionalProperties – ob unbekannte Felder bei der Validierung fehlschlagen sollen. Ein Beispiel zeigt eine Instanz; Sie kennen die Regeln.
Wo das Schema dann funktioniert: Validierung eingehender API-Anfragen, bevor sie auf die Geschäftslogik treffen, OpenAPI/Swagger-Definitionen (die das JSON-Schema einbetten), Konfigurationsvalidierung in CI und automatische Vervollständigung des Editors – VS Code liest Schemata, um JSON-Dateien während der Eingabe automatisch zu vervollständigen und zu lintieren. Verwenden Sie ein repräsentatives Beispiel: Eine Nutzlast mit einem Null- oder leeren Array lehrt den Inferrer weniger als ein vollständig gefülltes Array.