Przewodnik po walidacji schematu — schemat JSON i OpenAPI

Przed wydaniem zweryfikuj ładunki JSON pod kątem schematów i specyfikacji OpenAPI.

Dryf schematu cicho psuje klientów. CI powinien sprawdzać odpowiedzi pod kątem schematu JSON i kontraktów OpenAPI w każdej wersji.

Tentaco Schema Studio wnioskuje schematy na podstawie próbek i lokalnie sprawdza poprawność ładunków podczas programowania.

Kroki

Wklej przykładowy JSON — uruchom generator schematu JSON, aby wywnioskować schemat wersji roboczej 07.
Edytuj wymagane pola i wyliczenia, aby dopasować je do reguł biznesowych.
Zweryfikuj odpowiedzi przypominające produkcyjne za pomocą narzędzia JSON Schema Validator.
Lint pełna specyfikacja OpenAPI — napraw zepsute $ref i brakujące identyfikatory operacji.
Dodaj zweryfikowane artefakty schematu do repozytorium w celu ponownego wykorzystania potoku CI.