JSON-Schema-Validator

Unterstützte Schlüsselwörter

Kern: type, enum, const, multipleOf, maximum, minimum, exclusiveMaximum, exclusiveMinimum, maxLength, minLength, pattern, maxItems, minItems, uniqueItems, maxContains, minContains, maxProperties, minProperties, required, dependentRequired.

Zusammensetzung: allOf, anyOf, oneOf, not.

Anwender: properties, patternProperties, additionalProperties, items, prefixItems, contains, propertyNames.

Bedingungen: if, then, else, dependentSchemas.

Referenzen: $ref, $defs, $id, $anchor.

Formate (mit Validierung, wenn aktiviert): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex.

Fehlerausgabe

FAIL  /user/email        format            "not-an-email" ist kein gültiges "email"
FAIL  /user/age          minimum           -3 ist kleiner als das Minimum 0
FAIL  /orders/0/total    type              "42" ist nicht vom Typ "number"
FAIL  /                  required          fehlende erforderliche Eigenschaft "shippingAddress"

Jeder Fehler enthält den Pfad und das Schlüsselwort, das fehlgeschlagen ist, was es einfach macht, es in Ihrem Editor zu finden.

Entwurfsunterschiede, die Probleme verursachen

Stellen Sie den richtigen Entwurf ein; die Validierung eines Entwurfs-04-Schemas als 2020-12 wird id und einige andere Feinheiten falsch interpretieren.

Typische Arbeitsabläufe

• API-Vertragstests: Führen Sie vor einem Deployment das generierte/aktualisierte OpenAPI-Schema gegen echte Beispielantworten aus.
• Konfigurationshärtung: Validieren Sie jede YAML/JSON-Konfiguration in CI gegen ein Schema, bevor Sie zusammenführen.
• Datenaufnahme: Lehnen Sie Payloads ab, die nicht der erwarteten Struktur entsprechen, frühzeitig mit einer klaren Fehlermeldung.

Häufige Fehler

• Vergessen der Durchsetzung von format. Standardmäßig behandeln die meisten Validatoren unbekannte Formate nur als Annotation. Aktivieren Sie die strikte Formatvalidierung, um tatsächlich ungültige E-Mails und Daten abzulehnen.
• Übermäßige Verwendung von oneOf. Wenn zwei Zweige von oneOf sich überschneiden, schlägt das Dokument fehl (es muss genau einem entsprechen). Verwenden Sie anyOf oder Diskriminator-Muster.
• Strenge Schemata mit additionalProperties: false. Das Hinzufügen eines neuen optionalen Feldes wird zu einer brechenden Änderung. Lassen Sie es weg, es sei denn, Sie möchten wirklich ein geschlossenes Objekt.