JSON Schema-validator

Ondersteunde sleutelwoorden

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

Samenstelling: allOf, anyOf, oneOf, not.

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

Voorwaardelijk: if, then, else, dependentSchemas.

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

Formaten (met validatie wanneer ingeschakeld): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex.

Foutuitvoer

FAIL  /user/email        format            "not-an-email" is not a valid "email"
FAIL  /user/age          minimum           -3 is less than the minimum 0
FAIL  /orders/0/total    type              "42" is not of type "number"
FAIL  /                  required          missing required property "shippingAddress"

Elke fout bevat het pad en het mislukte sleutelwoord, zodat u het snel in uw editor kunt terugvinden.

Ontwerpverschillen die problemen veroorzaken

Stel het juiste ontwerp in; een schema van ontwerp 04 valideren als 2020-12 zal id en enkele andere subtiliteiten verkeerd interpreteren.

Typische workflows

• API-contracttests: voer vóór een implementatie het gegenereerde/bijgewerkte OpenAPI-schema uit tegen echte voorbeeldantwoorden.
• Configuratie verstevigen: valideer elke YAML/JSON-configuratie in de CI aan de hand van een schema voordat u samenvoegt.
• Gegevensinvoer: weiger payloads die niet overeenkomen met de verwachte vorm vroegtijdig, met een duidelijke foutmelding.

Veelvoorkomende fouten

• Het afdwingen van format vergeten. Standaard behandelen de meeste validators onbekende formaten alleen als annotatie. Schakel strikte formaatvalidatie in om ongeldige e-mails en datums daadwerkelijk af te wijzen.
• Overmatig gebruik van oneOf. Als twee takken van oneOf elkaar overlappen, mislukt het document (het moet precies met één overeenkomen). Gebruik anyOf of discriminatorpatronen.
• Strakke schema’s met additionalProperties: false. Het toevoegen van een nieuw optioneel veld wordt een brekende wijziging. Laat het weg, tenzij u echt een gesloten object wilt.