Amorcer une spécification OpenAPI à partir du trafic API capturé avant le client ou l'automatisation des tests
Utilise mitmproxy2swagger pour transformer les flux mitmproxy capturés ou les exportations HAR en un document OpenAPI de première passe qu'un agent peut affiner, valider et transmettre aux outils en aval. Invoquez-le lorsque l'API existe déjà mais que le contrat n'existe pas, et que vous avez besoin d'une spécification concrète avant de générer des clients, des mocks, des tests ou de la documentation révisable.
Prérequis
Python 3 et pip, plus des captures de flux mitmproxy ou une exportation HAR depuis les DevTools du navigateur
Installation
Utilisez le chemin d'installation upstream ou de configuration qui correspond à votre environnement :
- $ pip install mitmproxy2swagger
- $ git clone [email protected]:alufers/mitmproxy2swagger.git
- $ docker build -t mitmproxy2swagger .
- $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <chemin_vers_flux_mitmproxy> -o <chemin_vers_schéma_sortie> -p <préfixe_api>
Exigences et avertissements upstream :
- poetry pour la gestion des dépendances
Notes d'utilisation de base ou de démarrage :
-
Vous aurez d'abord besoin de python3 et pip3.
-
bash
-
... ou ...
-
Extrait de la documentation upstream : https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md