Wizualizator specyfikacji OpenAPI
Wizualizator specyfikacji OpenAPI pomaga szybko zrozumieć nieznane API; linter w CI zapobiega rozjeżdżaniu się specyfikacji z kodem.
🔒 To narzędzie działa w całości w Twojej przeglądarce. Twoje pliki nigdy nie są wysyłane na serwer.
Deweloper
Wizualizator specyfikacji OpenAPI
Podgląd interfejsu — bez przesyłania i usług zewnętrznych.
Mapa endpointów
Specyfikacja o długości 2400 linii wyświetlona jako 8 grup wg tagów obejmujących 47 endpointów, z 3 ścieżkami oznaczonymi jako bez podsumowania i 2 schematami zdefiniowanymi, ale nigdy nieużywanymi.
Jak działa Wizualizator specyfikacji OpenAPI
- Wklej dokument OpenAPI lub Swagger w formacie JSON lub YAML.
- Grupuj według tagu, aby zobaczyć API tak, jak zorganizowali je autorzy, albo według prefiksu ścieżki, aby zobaczyć strukturę zasobów.
- Szukaj endpointów bez opisu i schematów, do których nic się nie odwołuje — obie rzeczy oznaczają, że specyfikacja odbiegła od implementacji.
FAQ
Jakie wersje OpenAPI działają?
Parsowane są zarówno OpenAPI 3.x, jak i Swagger 2.0. Różnią się sposobem deklarowania treści żądań i zabezpieczeń, co warto wiedzieć, czytając starą specyfikację obok nowej.
Czy to waliduje specyfikację?
Zgłasza oczywiste problemy strukturalne, takie jak nieużywane schematy i brakujące podsumowania. Pełna walidacja wobec specyfikacji wymaga dedykowanego lintera, np. Spectral, który egzekwuje też zasady stylu firmowego.
Czy moja specyfikacja jest przesyłana?
Nie. Parsowanie odbywa się w przeglądarce, co ma znaczenie, gdy specyfikacja opisuje wewnętrzne API i wymienia każdy jego endpoint i pole.
Porównanie
| Funkcja | Online Tool Store | Skrypt CLI | Wtyczka do IDE |
|---|---|---|---|
| Nic nie jest przesyłane | ✓ | ✗ | Zależy |
| Zgrupowany widok | ✓ | ✓ | ✗ |
| Oznacza nieużywane schematy | ✓ | ✗ | ✗ |
| Brak instalacji | ✓ | ✗ | ✓ |
Wizualizator specyfikacji OpenAPI pomaga szybko zrozumieć nieznane API; linter w CI zapobiega rozjeżdżaniu się specyfikacji z kodem.