mitmproxy2swagger

https://user-images.githubusercontent.com/5400940/168086818-c48f60ab-3f95-42eb-b435-c8b1a6326b81.mp4

Uma ferramenta para converter automaticamente capturas do mitmproxy em especificações OpenAPI 3.0. Isso significa que você pode reverter a engenharia de APIs REST automaticamente apenas executando os aplicativos e capturando o tráfego.

🆕 NOVO!

Adicionado suporte para processar HAR exportado do DevTools do navegador. Veja Uso - HAR para mais detalhes.

Instalação

Primeiro você precisará de python3 e pip3.

$ pip install mitmproxy2swagger
# ... or ...
$ pip3 install mitmproxy2swagger
# ... or ...
$ git clone [email protected]:alufers/mitmproxy2swagger.git
$ cd mitmproxy2swagger
$ docker build -t mitmproxy2swagger .

Em seguida, clone o repositório e execute mitmproxy2swagger conforme os exemplos abaixo.

Uso

Mitmproxy

Para criar uma especificação inspecionando o tráfego HTTP, você precisará:

1. Capture o tráfego usando a ferramenta mitmproxy. Eu pessoalmente recomendo usar o mitmweb, que é uma interface web embutida no mitmproxy.

   root@kitploit:~

   $ mitmweb
   Web server listening at http://127.0.0.1:8081/
   Proxy server listening at http://*:9999
   ...
   

   IMPORTANTE

   Para configurar seu cliente para usar o proxy exposto pelo mitmproxy, consulte a documentação do mitmproxy para mais informações.

2. Salve o tráfego em um arquivo de fluxo.

   No mitmweb você pode fazer isso usando o menu "Arquivo" e selecionando "Salvar":

   

3. Execute a primeira passagem do mitmproxy2swagger:

   root@kitploit:~

   $ mitmproxy2swagger -i <caminho_para_fluxo_mitmproxy> -o <caminho_para_esquema_saida> -p <prefixo_api>
   # ... ou ...
   $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <caminho_para_fluxo_mitmproxy> -o <caminho_para_esquema_saida> -p <prefixo_api>
   

   Observe que você pode usar um esquema existente; nesse caso, o esquema existente será estendido com os novos dados. Você também pode executá-lo algumas vezes com diferentes capturas de fluxo; os dados capturados serão mesclados com segurança.

   <prefixo_api> é a url base da API da qual você deseja fazer engenharia reversa. Você precisará obtê-la observando as requisições feitas no mitmproxy.

   Por exemplo, se um aplicativo fez requisições como estas:

   root@kitploit:~

   https://api.example.com/v1/login
   https://api.example.com/v1/users/2
   https://api.example.com/v1/users/2/profile
   

HAR

1. Capture e exporte o tráfego do DevTools do navegador.

   No DevTools do navegador, vá para a aba "Rede" e clique no botão "Exportar HAR".

   

2. Continue da mesma forma que faria com o dump do mitmproxy. O mitmproxy2swagger detectará automaticamente o arquivo HAR e o processará.

Exemplo de saída

Veja os exemplos. Você encontrará um esquema gerado lá e um arquivo html com a documentação gerada (via redoc-cli).

Veja o arquivo html gerado.

Desenvolvimento e contribuição

Este projeto usa:

• uv para gerenciamento de dependências
• prek para formatação e linting de código
• pytest para testes unitários

Para instalar as dependências:

uv sync

Execute linters:

uv run prek run --all-files

Instale hooks do prek:

uv run prek install

Execute testes:

uv run pytest

Execute testes com cobertura:

uv run pytest --cov=mitmproxy2swagger

Licença

MIT