MitmProxy2Swagger – Tool für automatisches Reverse Engineering von REST-APIs

 (github.com/alufers)
36 Punkte von xguru 2025-01-03 | 4 Kommentare | Auf WhatsApp teilen
  • Ein Tool, das mit mitmproxy erfassten HTTP-Traffic automatisch in eine OpenAPI-3.0-Spezifikation umwandelt
  • REST-APIs lassen sich durch Ausführen der App und Erfassen des Traffics per Reverse Engineering rekonstruieren
  • Unterstützung für die Verarbeitung von HAR-Dateien hinzugefügt, die aus den Browser-DevTools exportiert wurden
  • Funktionsweise
    • HTTP-Traffic über mitmproxy erfassen (empfohlen: mitmweb verwenden)
    • Den Traffic speichern und danach mitmproxy2swagger ausführen; nach der Analyse wird ein OpenAPI-Schema erzeugt
    • Im erzeugten YAML-Schema bei den benötigten Pfaden ignore: entfernen und Details anpassen
    • mitmproxy2swagger auf Basis des angepassten Schemas erneut ausführen, um die endgültige Spezifikation zu erzeugen
  • Zusammen mit dem erzeugten Schema wird über redoc-cli auch eine automatisch generierte dokumentierte HTML-Datei bereitgestellt

Verwandte Beiträge

4 Kommentare

 
yangeok 2025-01-05

Großartig.
 
dooboo 2025-01-03

Wow, die Idee ist wirklich großartig~
 
bungker 2025-01-03

Beim Entwickeln kommt es oft vor, dass APIs nicht dokumentiert sind oder nicht der Dokumentation bzw. Spezifikation entsprechen; dabei scheint das sehr hilfreich zu sein.
 
xguru 2025-01-03

API Parrot – Tool für automatisches Reverse Engineering von HTTP-APIs ist Closed Source, daher wird dieses Tool hier offenbar ebenfalls diskutiert.

Siehe dazu auch die Kommentare auf Hacker News: https://news.ycombinator.com/item?id=42572662