Preskoči na vsebino
100% lokalno

Seznam OpenAPI končnih točk

Izvucite vse končne točke iz OpenAPI ali Swagger dokumenta kot berljivo tabelo.

Vhod
Izhod

Seznam OpenAPI končnih točk

Prilepite OpenAPI ali Swagger dokument — JSON ali YAML, OpenAPI 3 ali Swagger 2 — in to orodje izvleče vse končne točke v berljiv seznam. Izdelano je za trenutek, ko dobite datoteko specifikacije in potrebujete hiter pregled, preden se spustite v podrobnosti: katere rute obstajajo, kaj potrebujejo in kaj vrnejo.

Filtriranje seznama po HTTP metodi ali oznaki, da se osredotočite na en del API-ja. Vklapljajte parametre poti in poizvedbe, vrsto vsebine zahtevka, kode odgovorov in ali je potrebna avtentifikacija — orodje prebere zahteve za varnost za posamezno operacijo in se vrne na globalno varnost dokumenta, če operacija ne prepiše. Vključite "Preskoči zastarele končne točke", da skrijete rute, označene kot zastarele v specifikaciji, in vključite povzetek vsake končne točke za dodatni kontekst brez odpiranja izvorne datoteke.

Rezultat razvrstite po poti ali oznaki ter izberite obliko izhodnega rezultata, ki se ujema s tem, kar potrebujete: navaden seznam za hiter pregled, Markdown tabelo za lepljenje v dokumentacijo ali zahtevo za povleko, ali CSV za odpiranje v pregledniku. Parametri, definirani z $ref namesto vrstično, so preskoči namesto ugibanja, saj bi pravilno razrešitev sklica potrebovalo preostalo del dokumenta.

Vse se izvaja lokalno v vašem brskalniku — specifikacija API-ja nikoli ne zapusti vaše naprave, kar je pomembno, ko opisuje notranjo ali neobjavljeno storitev. Kopirajte rezultat, ga prenesite kot datoteko .txt ali ga pošljite neposredno v drugo orodje za nadaljevanje dela.

FAQ

Ali podpira tako OpenAPI 3 kot Swagger 2?
Da. Oba formata držita končne točke v oddelku "paths" z isto obliko, zato ista čitalka upravlja katero koli verzijo.
Kako odloči, ali je končna točka potrebna avtentifikacija?
Prvo preverí svoje polje "security" operacije. Prazen niz tam pomeni, da ta končna točka eksplicitno onemogoči avtentifikacijo; če polje manjka, se orodje vrne na globalno nastavilo "security" dokumenta.
Ali lahko razreši $ref reference?
Ne za parametre — parameter, definiran z $ref, nima imena v vrstici, zato je preskoči namesto razrešitve, saj bi to potrebovalo branja preostale del dokumenta.
Kaj se zgodi z neveljavnim ali nepovezanim dokumentom?
Videli boste jasno sporočilo: eno za besedilo, ki ni veljaven JSON ali YAML, in drugo, ko se dokument pravilno razčleni, vendar nima razdelka "paths".
Ali je moja API specifikacija nekje naložena?
Ne. Razčlenjenje in oblikovanje se dogajata v celoti v vašem brskalniku — dokument, ki ga prilepite, nikoli ne zapusti vaše naprave.