OpenAPI-Spezifikation aus aufgezeichnetem API-Traffic bootstrappen (vor Client- oder Testautomatisierung)
Nutzt mitmproxy2swagger, um aufgezeichnete mitmproxy-Flows oder HAR-Exporte in ein erstes OpenAPI-Dokument zu verwandeln, das ein Agent verfeinern, validieren und an nachgelagerte Tools übergeben kann. Verwenden Sie es, wenn die API bereits existiert, aber kein Vertrag vorliegt, und Sie eine konkrete Spezifikation benötigen, bevor Sie Clients, Mocks, Tests oder überprüfbare Dokumentation generieren.
Voraussetzungen
Python 3 und pip, sowie mitmproxy-Flow-Aufzeichnungen oder ein HAR-Export aus den Browser-DevTools
Installation
Verwenden Sie die für Ihre Umgebung passende Installations- oder Einrichtungsmethode:
- $ pip install mitmproxy2swagger
- $ git clone [email protected]:alufers/mitmproxy2swagger.git
- $ docker build -t mitmproxy2swagger .
- $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <pfad_zu_mitmproxy_flow> -o <pfad_zu_ausgabe_schema> -p <api_präfix>
Anforderungen und Hinweise des Upstream-Projekts:
- poetry für das Abhängigkeitsmanagement
Grundlegende Nutzung oder Einstiegsnotizen:
-
Zuerst benötigen Sie Python3 und pip3.
-
bash
-
... oder ...
-
Aus den Upstream-Dokumenten extrahiert: https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md