Ugrás a tartalomhoz
100% helyi

OpenAPI végpont listázó

Az OpenAPI vagy Swagger dokumentum minden végpontja olvasható táblázatként.

Bemenet
Kimenet

OpenAPI végpont listázó

Illesszen be egy OpenAPI vagy Swagger dokumentumot — JSON vagy YAML formátumban, OpenAPI 3 vagy Swagger 2 — és az eszköz minden végpontot okunható listává alakít. Akkor hasznos, amikor egy specifikáció fájlt kapnak és gyors áttekintésre van szükség a részletekbe merülés előtt: mely útvonalak léteznek, mire van szükségük, és mit adnak vissza.

Szűrje a listát HTTP metódus vagy címke alapján, hogy az API egy részére összpontosítson. Kapcsolja be vagy ki az útvonal és lekérdezés paramétereket, a kérés törzse tartalmának típusát, a válaszkódokat és azt, hogy végpontnak szüksége van-e hitelesítésre — az eszköz biztonsági követelményeket olvas műveletenként, ha az operáció nem felülírja, akkor a dokumentum globális biztonsági beállításaira esik vissza. Kapcsolja be az "Elavult végpontok kihagyása" opciót a specifikációban elavultként megjelölt útvonalak elrejtéséhez, és adja meg minden végpont összefoglalási mezőjét további kontextushoz a forrásfájl megnyitása nélkül.

Rendezze az eredményt útvonal vagy címke alapján, és válasszon kimeneti formátumot, amely megfelel a következő lépésnek: egyszerű lista a gyors áttekintéshez, Markdown táblázat a dokumentáció vagy pull kérés beillesztéséhez, vagy CSV a táblázatkezelőben való megnyitáshoz. Az olyan paraméterek, amelyek $ref helyett beágyazva vannak megadva, kihagyásra kerülnek, nem pedig kitalálva, mivel a referencia helyes feloldásához a dokumentum többi részére van szükség.

Minden helyileg fut a böngészőben — az API specifikáció soha nem hagyja el az eszközöt, ami fontos, amikor belső vagy nem publikált szolgáltatást ír le. Másolja az eredményt, töltse le .txt fájlként, vagy küldje egyenesen egy másik eszközbe a munka folytatásához.

Gyakori kérdések

Támogatja az OpenAPI 3-at és a Swagger 2-t is?
Igen. Mindkét formátum az "útvonalak" szakasz alatt tartja az végpontokat ugyanazzal az alakkal, így az ugyanaz az olvasó kezeli mindkét verziót.
Honnan tudja, hogy egy végpont hitelesítésre szorul?
Először az operáció saját "biztonsági" mezőjét ellenőrzi. Az üres tömb ott azt jelenti, hogy ez a végpont kifejezetten letiltja a hitelesítést; ha a mező hiányzik, az eszköz a dokumentum globális "biztonsági" beállítására esik vissza.
Meg tudja oldani a $ref hivatkozásokat?
Nem, a paraméterekre nézve — egy $ref -fel definiált paraméternek nincs beágyazott neve, így kihagyásra kerül, és nem oldódik fel, mivel a dokumentum többi részét kellene olvasni.
Mi történik, ha az érvénytelen vagy nem kapcsolódó dokumentum?
Egyértelmű üzenetet fog látni: az egyik a nem érvényes JSON vagy YAML szöveghez, a másik pedig akkor jelenik meg, ha a dokumentum megfelelően feldolgozható, de nincs "útvonalak" szakasz.
Az API specifikációm valahova fel lesz töltve?
Nem. Az elemzés és formázás teljesen a böngészőben történik — az összefoglalt dokumentum soha nem hagyja el az eszközt.