Bootstrap de especificação OpenAPI a partir de tráfego de API capturado antes da automação de cliente ou teste
Usa mitmproxy2swagger para converter fluxos mitmproxy capturados ou exportações HAR em um documento OpenAPI preliminar que um agente pode refinar, validar e repassar para ferramentas downstream. Invoke-o quando a API já existir, mas o contrato não, e você precisar de uma especificação concreta antes de gerar clientes, mocks, testes ou documentação revisável.
Pré-requisitos
Python 3 e pip, além de capturas de fluxo mitmproxy ou uma exportação HAR das DevTools do navegador
Instalação
Use o caminho de instalação upstream ou configuração que corresponda ao seu ambiente:
- $ pip install mitmproxy2swagger
- $ git clone [email protected]:alufers/mitmproxy2swagger.git
- $ docker build -t mitmproxy2swagger .
- $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <caminho_para_fluxo_mitmproxy> -o <caminho_para_esquema_saida> -p <prefixo_api>
Requisitos e observações do upstream:
- poetry para gerenciamento de dependências
Notas de uso básico ou primeiros passos:
-
Primeiro você precisará de python3 e pip3.
-
bash
-
... ou ...
-
Extraído de documentação upstream: https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md