Walidator JSON Schema

Obsługiwane słowa kluczowe

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

Kompozycja: allOf, anyOf, oneOf, not.

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

Warunki: if, then, else, dependentSchemas.

Odwołania: $ref, $defs, $id, $anchor.

Formaty (z walidacją po włączeniu): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex.

Wynik błędu

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"

Każdy błąd zawiera ścieżkę i słowo kluczowe, które zawiodło, co czyni szybkim zlokalizowanie go w edytorze.

Różnice między draftami, które gryzą

Ustaw właściwy draft; walidacja schematu draft-04 jako 2020-12 błędnie zinterpretuje id i kilka innych subtelności.

Typowe przepływy pracy

• Testowanie kontraktu API: przed wdrożeniem uruchom wygenerowany/zaktualizowany schemat OpenAPI względem rzeczywistych przykładowych odpowiedzi.
• Utwardzanie konfiguracji: waliduj każdą konfigurację YAML/JSON w CI względem schematu przed scaleniem.
• Wczytywanie danych: wcześnie odrzucaj ładunki, które nie pasują do oczekiwanego kształtu, z jasnym komunikatem błędu.

Częste błędy

• Zapominanie o egzekwowaniu format. Domyślnie większość walidatorów traktuje nieznane formaty tylko jako adnotację. Włącz walidację strict-format, aby faktycznie odrzucać błędne e-maile i daty.
• Nadużywanie oneOf. Jeśli dwie gałęzie oneOf się nakładają, dokument zawiedzie (musi pasować dokładnie do jednej). Użyj anyOf albo wzorców z dyskryminatorem.
• Ciasne schematy z additionalProperties: false. Dodanie nowego opcjonalnego pola staje się zmianą łamiącą. Pomiń je, chyba że naprawdę chcesz obiektu zamkniętego.