Pode implementar o Agente Proxy de Pedidos do Apidog numa máquina com o ambiente de rede adequado. Isto permite que pedidos de endpoints provenientes do cliente Apidog, da web ou de documentação partilhada sejam encaminhados através deste agente para o endpoint de destino.Esta funcionalidade é particularmente útil para depurar endpoints em documentações partilhadas, pois ajuda a resolver problemas de partilha de recursos entre origens (CORS). É 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 a executar Linux.
Docker instalado no servidor (versão mínima necessária: 20.10.0. Versão recomendada: 20.10.13). Implementar o Agente Proxy de Pedidos#
O agente proxy de pedidos é um recurso ao nível da equipa/organização. Depois de implementado, pode ser utilizado em todos os projetos da sua equipa ou organização. Para implementar o agente num servidor com Docker ativado, execute o seguinte comando:Pode configurar definições básicas através de variáveis de ambiente durante a implementação. Utilize 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 operativo, esta variável só pode ser utilizada em Linux e deve ser utilizada 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 operativo, esta variável só pode ser utilizada em Linux e deve ser utilizada 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 pedidos para IPs internos (booleano, a predefinição é false) | -e ALLOW_PRIVATE_IP=false |
O Agente Proxy de Pedidos do Apidog é open-source, permitindo-lhe personalizá-lo ainda mais para satisfazer as suas necessidades (por exemplo, adicionar parâmetros de cabeçalho personalizados). Aceda ao código-fonte aqui.
Adicionar o Agente Proxy de Pedidos no Apidog#
Depois de o agente proxy de pedidos do Apidog estar em execução no Docker, pode adicioná-lo aos recursos da equipa no Apidog. Introduza as informações do anfitrião do servidor (a porta predefinida é 9159) na janela pop-up e clique em guardar. Em seguida, o Apidog tentará estabelecer ligação.Se a ligação falhar, verá uma notificação e a criação não será permitida.
Se a ligação for bem-sucedida, o agente proxy de pedidos será criado com sucesso na sua equipa.
