Você pode implantar o Apidog Request Proxy Agent em uma máquina com o ambiente de rede apropriado. Isso permite que requisições de endpoint do cliente Apidog, da web ou de documentações compartilhadas sejam roteadas por meio desse agente até o endpoint de destino.Esse recurso é particularmente útil para depurar endpoints em documentações compartilhadas, pois ajuda a resolver problemas de compartilhamento de recursos entre origens (CORS). Ele é ideal para cenários em que diferentes ambientes têm requisitos de rede específicos, tornando impossível a depuração direta a partir de um ambiente local.Pré-requisitos#
Um servidor, de preferência executando Linux.
Docker instalado no servidor (versão mínima necessária: 20.10.0. Versão recomendada: 20.10.13). Implantação do Agente de Proxy de Requisições#
O agente de proxy de requisições é um recurso em nível de equipe/organização. Depois de implantado, ele pode ser usado em todos os projetos dentro da sua equipe ou organização. Para implantar o agente em um servidor habilitado para Docker, execute o seguinte comando:Você pode definir configurações básicas usando variáveis de ambiente durante a implantação. Use as seguintes opções conforme necessário:| Variável de ambiente | Descrição | Exemplo |
|---|
| SOURCE_IP_WHITELIST | Lista de IPs de origem permitidos, separados por vírgulas (devido a restrições do sistema operacional, essa variável só pode ser usada no Linux e deve ser usada com --network=host.) | --network=host -e SOURCE_IP_WHITELIST=134.34.4.3,123.333.33.0/24 |
| SOURCE_IP_BLACKLIST | Lista de IPs de origem bloqueados, separados por vírgulas (devido a restrições do sistema operacional, essa variável só pode ser usada no Linux e deve ser usada com --network=host.) | --network=host -e SOURCE_IP_BLACKLIST=134.34.4.3,123.333.33.0/24 |
| DESTINATION_DOMAIN_WHITELIST | Lista de nomes de domínio de destino permitidos, separados por vírgulas | -e DESTINATION_DOMAIN_WHITELIST=xxx.yyy.com,*.yyy.com |
| DESTINATION_DOMAIN_BLACKLIST | Lista de nomes de domínio de destino bloqueados, separados por vírgulas | -e DESTINATION_DOMAIN_BLACKLIST=xxx.yyy.com,*.yyy.com |
| DESTINATION_IP_WHITELIST | Lista de IPs de destino permitidos, separados por vírgulas | -e DESTINATION_IP_WHITELIST=134.34.4.3,123.333.33.0/24 |
| DESTINATION_IP_BLACKLIST | Lista de IPs de destino bloqueados, separados por vírgulas | -e DESTINATION_IP_BLACKLIST=134.34.4.3,123.333.33.0/24 |
| ALLOW_PRIVATE_IP | Permitir requisições para IPs internos (booleano; o padrão é false) | -e ALLOW_PRIVATE_IP=false |
O Apidog Request Proxy Agent é open-source, permitindo que você o personalize ainda mais para atender às suas necessidades (por exemplo, adicionando parâmetros de cabeçalho personalizados). Acesse o código-fonte aqui.
Adição do Agente de Proxy de Requisições no Apidog#
Depois que o agente de proxy de requisições do Apidog estiver em execução no Docker, você poderá adicioná-lo aos recursos da equipe no Apidog. Insira as informações de host do servidor (a porta padrão é 9159) na janela pop-up e clique em salvar. Em seguida, o Apidog tentará se conectar.Se a conexão falhar, você verá uma notificação e a criação não será permitida.
Se a conexão for bem-sucedida, o agente de proxy de requisições será criado com sucesso dentro da sua equipe.
Depois que o agente for implantado e conectado com sucesso no Apidog, ele poderá ser usado para: