JSON Schema-validator

Nyckelord som stöds

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

Sammansättning: allOf, anyOf, oneOf, not.

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

Villkorliga: if, then, else, dependentSchemas.

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

Format (med validering när det är aktiverat): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex.

Felutdata

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"

Varje fel anger både sökvägen och det nyckelord som misslyckades, vilket gör det enkelt att hitta i din editor.

Skillnader mellan utkast som ställer till problem

Ställ in rätt utkast; att validera ett schema med utkast 04 som 2020-12 kommer att feltolka id och en del andra finesser.

Typiska arbetsflöden

• Testning av API-kontrakt: kör det genererade/uppdaterade OpenAPI-schemat mot verkliga exempelsvar innan en driftsättning.
• Härdning av konfiguration: validera varje YAML/JSON-konfiguration i CI mot ett schema innan sammanslagning.
• Datainmatning: avvisa nyttolaster som inte matchar den förväntade formen tidigt, med ett tydligt felmeddelande.

Vanliga misstag

• Att glömma att framtvinga format. Som standard behandlar de flesta validatorer okända format som enbart annotering. Aktivera strikt formatvalidering för att faktiskt avvisa ogiltiga e-postadresser och datum.
• Överanvändning av oneOf. Om två grenar av oneOf överlappar misslyckas dokumentet (det måste matcha exakt en). Använd anyOf eller diskriminatormönster.
• Snäva scheman med additionalProperties: false. Att lägga till ett nytt valfritt fält blir en bakåtinkompatibel ändring. Utelämna det om du inte verkligen vill ha ett slutet objekt.