Przejdź do treści
100% lokalnie

OpenAPI lister końcowych punktów

Ekstrahuje każdy koncowy punkt z dokumentu OpenAPI lub Swagger do czytelnej listy.

Wejście
Wynik

OpenAPI lister końcowych punktów

Wklej dokument OpenAPI lub Swagger — JSON lub YAML, OpenAPI 3 lub Swagger 2 — a to narzędzie extrahuje każdy punkt końcowy do czytelnej listy. Został stworzony na wypadek, gdy otrzymasz plik specyfikacji i potrzebujesz szybkiego przeglądu przed zagłębieniem się w szczegóły: jakie trasy istnieją, co potrzebują i co zwracają.

Filtruj listę według metody HTTP lub tagu, aby skupić się na jednej części interfejsu API. Włącz lub wyłącz parametry ścieżki i zapytania, typ zawartości ciała żądania, kody odpowiedzi i czy punkt końcowy wymaga autentykacji — narzędzie odczytuje wymagania bezpieczeństwa na operację, a jeśli operacja nie zastępuje globalną konfigurację bezpieczeństwa dokumentu. Włącz opcję „Pomiń przestarzałe punkty końcowe" i ukryj trasy oznaczone jako przestarzałe w specyfikacji, a także uwzględnij pole streszczenia każdego punktu końcowego w celu uzyskania dodatkowego kontekstu bez otwierania pliku źródłowego.

Posortuj wynik według ścieżki lub tagu i wybierz format wyjścia zgodnie z Twoimi potrzebami: prostą listę do szybkiego przeglądu, tabelę Markdown do wklejenia w dokumentację lub wniosek o zmianę, lub CSV, aby otworzyć w arkuszu kalkulacyjnym. Parametry zdefiniowane za pomocą zamiast wstawiane są pomijane, ponieważ prawidłowe rozwiązanie odniesienia wymaga reszty dokumentu.

Wszystko działa lokalnie w Twojej przeglądarce — specyfikacja interfejsu API nigdy nie opuszcza Twojego urządzenia, co jest ważne, gdy opisuje wewnętrzną lub nie jeszcze wydaną usługę. Skopiuj wynik, pobierz go jako plik .txt lub wyślij go bezpośrednio do innego narzędzia, aby kontynuować pracę.

Częste pytania

Obsługuje OpenAPI 3 i Swagger 2?
Tak. Oba formaty przechowują punkty końcowe w sekcji „paths" o tej samej strukturze, więc ten sam czytnik obsługuje obie wersje.
Jak określa, czy punkt końcowy wymaga autentykacji?
Najpierw sprawdza własne pole „security". Pusta tablica tam oznacza, że punkt końcowy wyraźnie wyłącza auth; jeśli pole brakuje, narzędzie powraca do globalnego ustawienia „security" dokumentu.
Czy może rozwiązać odniesienia ?
Nie dla parametrów — parametr zdefiniowany za pomocą nie ma nazwy wstawionej, więc jest pomijany, a nie rozwiązywany, ponieważ wymagałoby to odczytania reszty dokumentu.
Co się stanie z nieprawidłowym lub niezwiązanym dokumentem?
Pojawi się jasna wiadomość: jedna dla tekstu, który nie jest prawidłowym JSON lub YAML, i inna, gdy dokument analizuje prawidłowo, ale nie ma sekcji "paths".
Czy moja specyfikacja interfejsu API jest gdzieś przesyłana?
Nie. Analiza i formatowanie odbywają się całkowicie w Twojej przeglądarce — dokument, który wklejasz, nigdy nie opuszcza Twojego urządzenia.