Preskočiť na obsah
100% lokálne

OpenAPI lister koncových bodov

Extrahuje každý koncový bod z OpenAPI alebo Swagger dokumentu do čitateľného zoznamu.

Vstup
Výstup

OpenAPI lister koncových bodov

Vložte OpenAPI alebo Swagger dokument — JSON alebo YAML, OpenAPI 3 alebo Swagger 2 — a tento nástroj extrahuje každý koncový bod do čitateľného zoznamu. Bol vytvený pre chvíľu, keď dostanete súbor špecifikácie a potrebujete si rýchly prehľad skôr, ako sa ponoríte do detailov: ktoré trasy existujú, čo potrebujú a čo vracajú.

Filtrujte zoznam podľa HTTP metódy alebo podľa značky, aby ste sa zamerali na jednu časť rozhrania API. Zapnite či vypnite parametre cesty a dotazu, typ obsahu tela požiadavky, kódy odpovedí a či koncový bod vyžaduje autentifikáciu — nástroj číta požiadavky bezpečnosti na operáciu a ak operácia nepretláči, vráti sa na globálne nastavenie bezpečnosti dokumentu. Zapnite funkciu „Preskočiť zastarané koncové body" a skryte trasy označené ako zastaranú v špecifikácii a zahrňte pole zhrnutia každého koncového bodu pre dodatočný kontext bez otvávania zdrojového súboru.

Triedite výsledok podľa cesty alebo značky a zvoľte si formát výstupu podľa potreby: jednoduchý zoznam pre rýchly prehľad, tabuľku Markdown na vloženie do dokumentácie alebo požiadavky na vyžiadanie zmeny, alebo CSV na otvorenie v tabuľkovom procesore. Parametre definované pomocou namiesto vloženého obsahu sa preskočia, pretože správne vyriešenie referencie vyžaduje zvyšok dokumentu.

Všetko beží lokálne vo vašom prehliadači — špecifikácia rozhrania API nikdy neopustí vaše zariadenie, čo je dôležité, keď opisuje internú alebo nie ešte vydanú službu. Skopírujte výsledok, stiahnite ho ako súbor .txt alebo ho pošlite priamo do iného nástroja a pokračujte v práci.

Časté otázky

Podporuje OpenAPI 3 aj Swagger 2?
Áno. Oba formáty uchovávajú koncové body v sekcii „paths" s rovnakou štruktúrou, takže rovnaká čítačka spracúva obe verzie.
Ako určí, či koncový bod vyžaduje autentifikáciu?
Najprv skontroluje svoje vlastné pole „security". Prázdne pole tam znamená, že koncový bod explicitne deaktivuje auth; ak pole chýba, nástroj sa vracia na globálne nastavenie „security" dokumentu.
Môže vyriešiť referencie ?
Nie pre parametre — parameter definovaný pomocou nemá vložené meno, takže sa preskoči namiesto vyriešenia, pretože to by vyžadovalo čítanie zvyšku dokumentu.
Čo sa stane s neplatným alebo nesúvisiacim dokumentom?
Zobrazí sa jasná správa: jedna pre text, ktorý nie je platný JSON alebo YAML, a ďalšia, keď sa dokument korektne analyzuje, ale nemá sekciu "paths".
Je moja špecifikácia rozhrania API niekde nahratá?
Nie. Analýza a formátovanie prebiehajú celkom vo vašom prehliadači — dokument, ktorý vložíte, nikdy neopustí vaše zariadenie.