Dla bezpiecznej i przewidywalnej pracy API konieczne jest ścisłe kontrolowanie, jakie dane są odbierane i zwracane. Wdrażamy wsparcie dla JSON Schema, formalnego opisu struktury danych, który pozwala na automatyczne sprawdzanie żądań i odpowiedzi po stronie serwera i klienta.
JSON Schema pomaga identyfikować błędy integracyjne, eliminować niestabilne zachowania, zapewnić interoperacyjność między systemami oraz poprawić interoperacyjność API.
Co daje JSON Schema
| Szansa | Co zapewnia |
|---|---|
| Kontrola struktury | Upewnij się, że obiekt pasuje do oczekiwanych pól i typów |
| Wymagane pola | Krytyczna kontrola atrybutów |
| Typyfikacja | Jasne sprawdzenie numerów, strun, tablic i tablic |
| Ograniczenia i formaty | Wsparcie dla minimalnej/maksymalnej długości, enum, wzór, format poczty elektronicznej itp. |
| Ponowne użycie | Tworzenie szablonów i komponentów wielokrotnego użytku |
Jak działa walidacja
1. Żądanie lub odpowiedź porównuje się z predefiniowanym schematem
2. Jeśli istnieją odchylenia, interfejs API zwraca błąd z wyjaśnieniem
3. Schematy mogą być połączone, dziedziczne, mogą być stosowane zasady warunkowe
4. Stosowane na każdym poziomie: zapytanie, ciało, nagłówki, parametry zapytania
Korzyści dla API i klientów
Ochrona przed nieprawidłowymi i złośliwymi danymi
Poprawa stabilności integracji i przewidywalności zachowań
Automatyczne testowanie i generowanie Moks opartych na obwodach
Możliwość korzystania z schematów w dokumentacji i Swagger/OpenAPI
Upraszcza wsparcie i skalowanie API
Tam, gdzie jest to szczególnie istotne
Platformy z zewnętrznymi integracjami i partnerskimi interfejsami API
Aplikacje mobilne i frontowe oczekujące na przejrzystą strukturę reakcji
Rurociągi CI/CD z automatycznym testem API
Systemy o dynamicznie zmieniających się parametrach i umowach
JSON Schema to podstawowa technologia do ścisłej i niezawodnej pracy API. To sprawia, że Twoje dane są sprawdzone, integracja i rozwój są bezpieczne.