Přeskočit na obsah
100% lokálně

OpenAPI lister koncových bodů

Extrahuje každý koncový bod z OpenAPI nebo Swagger dokumentu do čitelného seznamu.

Vstup
Výstup

OpenAPI lister koncových bodů

Vložte OpenAPI nebo Swagger dokument — JSON nebo YAML, OpenAPI 3 nebo Swagger 2 — a tento nástroj extrahuje každý koncový bod do čitelného seznamu. Byl vytvořen pro chvíli, kdy obdržíte soubor specifikace a potřebujete si rychlý přehled dříve, než se ponoříte do podrobností: které trasy existují, co potřebují a co vracejí.

Filtrujte seznam podle metody HTTP nebo podle značky, abyste se zaměřili na jednu část rozhraní API. Zapnout nebo vypnout parametry cesty a dotazu, typ obsahu těla požadavku, kódy odpovědí a zda koncový bod vyžaduje autentizaci — nástroj čte požadavky bezpečnosti na operaci a pokud operace neovride globální nastavení bezpečnosti dokumentu. Zapněte funkci „Přeskočit zastaralé koncové body" a skryjte trasy označené v specifikaci jako zastaralé a zahrňte pole souhrnu každého koncového bodu pro další kontext bez otevření zdrojového souboru.

Seřaďte výsledek podle cesty nebo značky a zvolte formát výstupu podle vašich potřeb: jednoduchý seznam pro rychlý přehled, tabulku Markdown pro vložení do dokumentace nebo žádosti o přijetí změn, nebo CSV pro otevření v tabulkovém procesoru. Parametry definované pomocí namísto vsazené se přeskočí, protože správné vyřešení odkazu vyžaduje zbytek dokumentu.

Všechno běží lokálně ve vašem prohlížeči — specifikace rozhraní API nikdy neopustí vaše zařízení, což je důležité, když popisuje interní nebo zatím nevydanou službu. Zkopírujte výsledek, stáhněte jej jako soubor .txt nebo jej pošlete přímo do jiného nástroje a pokračujte v práci.

Časté dotazy

Podporuje OpenAPI 3 i Swagger 2?
Ano. Oba formáty uchovávajú koncové body v sekcii „paths" se stejným tvarem, takže stejný čtenář zpracovává obě verzie.
Jak určí, zda koncový bod vyžaduje autentizaci?
Nejdříve zkontroluje vlastní pole „security". Prázdné pole tam znamená, že koncový bod explicitně deaktivuje auth; pokud pole chybí, nástroj se vrátí na globální nastavení „security" dokumentu.
Může vyřešit odkazy ?
Ne pro parametry — parametr definovaný pomocí nemá vloženého jméno, takže se přeskočí spíše než vyřešen, protože by to vyžadovalo čtení zbytku dokumentu.
Co se stane s neplatným nebo nesouvisejícím dokumentem?
Zobrazí se jasná zpráva: jedna pro text, který není platný JSON nebo YAML, a další, když se dokument správně parsuje, ale nemá sekci "paths".
Je má specifikace rozhraní API nahrána někde?
Ne. Analýza a formátování probíhají zcela ve vašem prohlížeči — dokument, který vložíte, nikdy neopustí vaše zařízení.