Was ist JSON Schema?
JSON Schema ist ein von der IETF (Internet Engineering Task Force) definiertes Vokabular, mit dem Sie die Struktur, Einschränkungen und Validierungsregeln für JSON-Daten beschreiben können. Ein JSON Schema gibt an, welche Eigenschaften ein Objekt haben muss, welche Datentypen zulässig sind, Wertebereiche, Stringmuster, Arraylängen und mehr. Es wird häufig für die Validierung von API-Anfragen/Antworten, Formulargenerierung, Validierung von Konfigurationsdateien und Datendokumentation verwendet. JSON Schema unterstützt Entwürfe von Draft-04 bis Draft 2020-12. Mit diesem Tool können Sie automatisch ein JSON Schema aus Beispiel-JSON-Daten generieren (nützlich als Ausgangspunkt) und jedes JSON-Dokument mithilfe der Ajv-Bibliothek (Another JSON Validator), dem am häufigsten verwendeten JSON Schema-Validator im JavaScript-Ökosystem, gegen ein Schema validieren.
So verwenden Sie dieses kostenlose Online JSON Schema Tool
- 1Wählen Sie zwischen 'Generate Schema' und 'Validate JSON' mit den Registerkarten oben.
- 2Um ein Schema zu erzeugen: Fügen Sie ein Beispiel JSON-Objekt in den Eingabebereich ein. Das Tool schließt automatisch auf Typen und generiert eine JSON Schema, die Sie als Ausgangspunkt verwenden können.
- 3Um JSON zu validieren: Fügen Sie die JSON-Daten, die Sie validieren möchten, im ersten Feld ein und fügen Sie die JSON Schema im zweiten Feld ein. Klicken Sie auf den 'Validate' Button.
- 4Überprüfen Sie das Validierungsergebnis: eine grüne Nachricht bedeutet, dass die JSON dem Schema entspricht; eine rote Nachricht listet alle Validierungsfehler mit ihren Pfaden auf.
- 5Klicken Sie auf die Schaltfläche Kopieren, um das generierte Schema oder die Validierungsergebnisse zu kopieren.
Häufige Anwendungsfälle für JSON Schema
API-Vertragsvalidierung
Definieren Sie JSON Schemas für Ihre API Anfrage- und Antwortstellen, um sicherzustellen, dass Clients gültige Daten senden und Server erwartete Strukturen zurückgeben.
Validierung von Konfigurationsdateien
Erstellen Sie Schemata für Anwendungskonfigurationsdateien, um Fehler frühzeitig zu erkennen - bevor sie Laufzeitfehler in der Produktion verursachen.
Schemata aus Beispielen erzeugen
Bootstrap ein JSON Schema aus Beispieldaten, anstatt eines von Grund auf neu zu schreiben. Verfeinern Sie das generierte Schema, indem Sie Einschränkungen wie erforderliche Felder und Muster hinzufügen.
Formularerstellung und Validierung
JSON Schema wird von Bibliotheken wie respond-JSONschema-form und vue-JSONschema-form verwendet, um automatisch UI-Formulare mit eingebauter Validierung zu generieren.
Qualitätsprüfung der Datenpipeline
Validieren Sie eingehende Daten in ETL-Pipelines mit einem Schema, um fehlerhafte Datensätze abzulehnen, bevor sie Ihr Data Warehouse beschädigen.
Häufig gestellte Fragen
Welchen JSON Schema-Entwurf unterstützt dieses Tool?
Die Validierungsmaschine (Ajv) unterstützt standardmäßig JSON Schema Draft-07, den am weitesten verbreiteten Entwurf. Der Schemagenerator erzeugt Schemata, die mit Draft-04 und höher kompatibel sind. Für die Funktionen von Draft 2019-09 oder 2020-12 müssen Sie möglicherweise die Plugins von ajv-Formaten oder ajv-Keywords hinzufügen.
Wie genau ist das autogenerierte Schema?
Das generierte Schema leitet Typen aus den von Ihnen bereitgestellten Beispieldaten ab - es bestimmt String-, Zahlen-, Boolesche-, Array- und Objekttypen genau. Es kann jedoch keine Einschränkungen wie minimale/maximale Werte, Stringmuster (Regex), erforderliche Felder oder Enum-Werte ableiten. Behandeln Sie das generierte Schema als Ausgangspunkt und verfeinern Sie es manuell.
Was bedeutet 'allErrors: true' in der Validierung?
Standardmäßig stoppt Ajv beim ersten Validierungsfehler. Mit 'allErrors: true' überprüft und meldet es jeden gefundenen Fehler und gibt Ihnen ein vollständiges Bild aller Probleme in einem Durchgang. Dies ist nützlicher für das Debuggen, aber etwas langsamer für sehr große Dokumente.
Ist dieses Tool kostenlos und privat?
Ja. Schema-Generierung und -Validierung laufen vollständig in Ihrem Browser mit dem to-JSON-Schema und Ajv JavaScript-Bibliotheken. Es werden keine Daten an einen Server gesendet und es ist keine Anmeldung erforderlich.