Walidator OpenAPI
Sprawdź dokument OpenAPI 3.0, 3.1 lub 3.2 albo Swagger 2.0 w YAML lub JSON i uzyskaj podsumowanie jego endpointów i schematów. Walidator sprawdza wymagane pola, zgodność szablonów ścieżek z parametrami ścieżek, lokalizacje parametrów, kody odpowiedzi, zduplikowane identyfikatory operacji i każde lokalne $ref, a także podaje lokalizację każdego problemu.
Najczęściej zadawane pytania
Co sprawdza walidator?
Sprawdza wersję openapi lub swagger, info.title i info.version, czy ścieżki zaczynają się od ukośnika, czy każdy {parameter} w ścieżce ma odpowiadający mu wymagany parametr ścieżki i odwrotnie, nazwy i lokalizacje parametrów, kody statusu i opisy odpowiedzi, zduplikowane parametry, zduplikowane wartości operationId oraz czy każde lokalne $ref wskazuje element w dokumencie.
Czy jest to pełna walidacja specyfikacji zgodnie ze schematem JSON?
Nie. Narzędzie sprawdza opisane wyżej reguły strukturalne, które wychwytują większość błędów w dokumentach pisanych ręcznie, ale nie waliduje każdego pola względem oficjalnego met schematu ani nie sprawdza zawartości schematów.
Co pokazuje podsumowanie?
Specyfikację i wersję API, tytuł, tabelę wszystkich endpointów z metodą, ścieżką, operationId, podsumowaniem i kodami odpowiedzi oraz nazwy schematów w sekcji components.schemas albo definicje w Swagger 2.0.
Czy śledzone są odwołania zewnętrzne?
Nie. Odwołania do innych plików lub adresów URL nie są pobierane ani zgłaszane. Wklejony dokument przeszukiwany jest tylko w celu rozwiązania odwołań zaczynających się od #.
Czym różnią się błędy od ostrzeżeń?
Błędy oznaczają naruszenie reguły specyfikacji, na przykład brak opisu odpowiedzi lub niezadeklarowany parametr ścieżki. Ostrzeżenia wskazują elementy dozwolone, ale zwykle niezamierzone, takie jak operacja GET z treścią żądania lub dokument bez żadnego operationId.
Czy OpenAPI 3.1 zmienia wymagania?
Tak. W OpenAPI 3.1 i 3.2 operacja nie musi już zawierać obiektu responses, a dokument może mieć webhooks lub components zamiast paths. Walidator stosuje te reguły, gdy pole openapi zaczyna się od 3.1 lub 3.2.