Zum Inhalt springen
100% lokal

OpenAPI-Endpunktlister

Jeden Endpunkt aus einem OpenAPI- oder Swagger-Dokument als lesbare Tabelle auflisten.

Eingabe
Ausgabe

OpenAPI-Endpunktlister

Füge ein OpenAPI- oder Swagger-Dokument ein — JSON oder YAML, OpenAPI 3 oder Swagger 2 — und dieses Tool extrahiert jeden Endpunkt in eine lesbare Liste. Es ist für den Moment konzipiert, in dem du eine Spezifikationsdatei erhältst und schnell einen Überblick brauchst, bevor du in die Details gehst: welche Routen existieren, was sie benötigen und was sie zurückgeben.

Filtern die Liste nach HTTP-Methode oder Tag, um dich auf einen Teil der API zu konzentrieren. Aktiviere Pfad- und Query-Parameter, den Content-Type des Request-Body, Response-Codes und ob ein Endpunkt eine Authentifizierung erfordert — das Tool liest Sicherheitsanforderungen pro Operation und fällt auf die globale Sicherheitseinstellung des Dokuments zurück, wenn eine Operation diese nicht überschreibt. Aktiviere "Veraltete Endpunkte überspringen", um als veraltet markierte Routen auszublenden, und beziehe das Zusammenfassungsfeld jedes Endpunkts für zusätzlichen Kontext ein, ohne die Quelldatei öffnen zu müssen.

Sortiere das Ergebnis nach Pfad oder Tag und wähle ein Ausgabeformat, das zu deinem nächsten Schritt passt: eine einfache Liste für einen schnellen Überblick, eine Markdown-Tabelle zum Einfügen in Dokumentation oder einen Pull Request oder CSV zum Öffnen in einem Tabellenkalkulationsprogramm. Parameter, die mit $ref definiert sind und nicht inline, werden übersprungen statt erraten, da eine korrekte Referenzauflösung den Rest des Dokuments benötigt.

Alles läuft lokal in deinem Browser — die API-Spezifikation verlässt dein Gerät nie, was wichtig ist, wenn sie einen internen oder noch nicht veröffentlichten Service beschreibt. Kopiere das Ergebnis, lade es als .txt-Datei herunter oder schicke es direkt in ein anderes Tool, um weiterzuarbeiten.

Häufige Fragen

Unterstützt es sowohl OpenAPI 3 als auch Swagger 2?
Ja. Beide Formate behalten Endpunkte unter einem "paths"-Abschnitt mit derselben Struktur, daher kann derselbe Reader beide Versionen verarbeiten.
Wie entscheidet es, ob ein Endpunkt eine Authentifizierung benötigt?
Es prüft zuerst das eigene "security"-Feld der Operation. Ein leeres Array dort bedeutet, dass dieser Endpunkt die Authentifizierung explizit deaktiviert; wenn das Feld fehlt, fällt das Tool auf die globale "security"-Einstellung des Dokuments zurück.
Kann es $ref-Referenzen auflösen?
Nein, für Parameter — ein Parameter, der mit $ref definiert ist, hat keinen Inline-Namen, daher wird er übersprungen statt aufgelöst, da das Auflösen einer Referenz korrekt den Rest des Dokuments benötigt.
Was passiert mit einem ungültigen oder unrelated-Dokument?
Du sehst eine klare Nachricht: eine für Text, der kein gültiges JSON oder YAML ist, und eine weitere, wenn das Dokument zwar einwandfrei geparst wird, aber keinen "paths"-Abschnitt hat.
Wird meine API-Spezifikation irgendwohin hochgeladen?
Nein. Analyse und Formatierung finden vollständig in deinem Browser statt — das Dokument, das du einfügst, verlässt dein Gerät nie.