Glossar   /   Datenformate

JSON Schema

JSON Schema beschreibt, welchen Aufbau und welche Werte JSON-Daten haben dürfen, und ermöglicht automatische Prüfungen.

Auch bekannt als: JSON-Schema

Was bedeutet JSON Schema?

Ein Schema kann beispielsweise eine Kundennummer verlangen und Mengen auf positive Zahlen beschränken. Damit werden erwartete Datenstrukturen maschinenlesbar festgelegt.

Die verwendete Schema-Version und das Verhalten des Prüfwerkzeugs müssen zusammenpassen. Auch ein bestandener Schematest beweist nicht, dass ein Kunde tatsächlich existiert oder ein Geschäftsvorgang erlaubt ist. Dafür sind weitere fachliche Prüfungen nötig.

So sieht das in der Praxis aus

Beispiel: Eine Auftragsschnittstelle prüft, ob eine Positionsliste vorhanden ist und jede Menge eine positive Zahl enthält.

Häufige Fragen

Kann ein Schema fehlende Pflichtfelder erkennen?

Ja, wenn sie ausdrücklich als erforderlich festgelegt sind. Ein Feld zu beschreiben macht es allein noch nicht automatisch zum Pflichtfeld.

Prüft jedes Werkzeug Datumsformate gleich?

Nein. Manche Werkzeuge behandeln eine Datumsformatangabe nur als Hinweis. Ob sie fehlerhafte Datumswerte tatsächlich ablehnen, hängt von Schema-Version und aktivierten Prüfoptionen ab.

Ersetzt das Schema fachliche Prüfungen?

Nein. Bestehende Kunden, erlaubte Statuswechsel oder aktuelle Berechtigungen lassen sich nicht allein durch die Form einer einzelnen Nachricht beurteilen.

Das könnte Sie auch interessieren

Passend zum Thema

API-Entwicklung Agentur Prüfregeln und Fehlerantworten an den Übergaben zwischen Anwendungen abstimmen.

Quellen und weiterführende Informationen

JSON Schema: What is JSON Schema? JSON Schema: String Formats and Validation
← Zurück zu allen Glossarbegriffen

Ungeeignete Eingaben früh erkennen

Fehlerhafte Daten sollen nicht unbemerkt weiterlaufen? Legen Sie technische und fachliche Prüfungen sowie verständliche Rückmeldungen für die betroffenen Vorgänge fest.

Kontakt aufnehmen