O Apidog fornece um mecanismo de mock eficiente que gera automaticamente respostas de API realistas com base nas suas especificações de API. Este recurso poderoso elimina a necessidade de configuração manual, acelerando os fluxos de trabalho de desenvolvimento e teste.Casos de uso#
APIs mock são valiosas em vários cenários de desenvolvimento e teste:| Cenário | Descrição | Benefício |
|---|
| Desenvolvimento paralelo | Desenvolvimento de frontend quando as APIs foram projetadas, mas ainda não implementadas | As equipes de frontend podem prosseguir sem aguardar a conclusão do backend |
| Segurança de dados | Evitar a exposição de dados de produção durante o desenvolvimento | Mantém a privacidade dos dados e a conformidade de segurança |
| Teste | Criar conjuntos de dados de teste para dependências externas | Garante dados de teste consistentes e controlados |
Primeiros passos#
1
Crie um endpoint ou importe uma especificação de API. O endpoint deve ter uma resposta especificada.
2
Navegue até a guia
Mock e clique na URL de mock para copiá-la.
3
Cole a URL no seu navegador para obter dados mock. Atualize a página para gerar novos dados.
Recursos de mock#
A funcionalidade de mock do Apidog oferece suporte a vários tipos de resposta:Tipos de servidores de mock#
O Apidog oferece três opções de servidor de mock para atender a diferentes necessidades de desenvolvimento:Mock local#
O mock local é executado no seu computador junto com o cliente Apidog. Ele opera apenas quando o cliente está aberto.Instalado automaticamente com o cliente Apidog
Inicia quando o cliente Apidog é iniciado
Acessível apenas enquanto o cliente está em execução
Não pode ser desativado nem removido dos ambientes
Ideal para: Depuração local de frontend e desenvolvimento individualDisponibilidade: Apenas no cliente Apidog (não disponível no Apidog Web)Encontre a URL do servidor de mock local no pop-up de gerenciamento de ambientes, em "Ambiente de mock local".
Mock na nuvem#
O mock na nuvem fornece a mesma funcionalidade do mock local, mas é executado nos servidores do Apidog. Ele permanece acessível independentemente de sua máquina local estar em execução.Hospedado nos servidores do Apidog
Disponível 24 horas por dia, 7 dias por semana, de qualquer local
Oferece suporte a acesso criptografado
Pode ser ativado/desativado conforme necessário
Ideal para: Ambientes de sandbox para APIs públicas e colaboração em equipeMock do runner#
O mock do runner opera na infraestrutura de runner auto-hospedada da sua equipe. Após implantar um runner no seu servidor, todos os membros da equipe podem acessar dados mock por meio dele.Auto-hospedado na sua infraestrutura
Disponível independentemente de máquinas locais
Compartilhado entre todos os membros da equipe
Ideal para: Testes automatizados em grande escala e ambientes de sandbox para APIs internas/privadasAcessar servidores de mock#
Você pode acessar dados mock por meio de dois métodos principais:Acesso por URL#
Cada endpoint HTTP no Apidog inclui um módulo Mock:No modo DESIGN: encontrado na guia API
No modo DEBUG: encontrado na guia Mock
Nesse módulo, você pode copiar a URL de mock e usá-la em qualquer aplicativo ou ferramenta para solicitar dados mock.Se um endpoint definir várias respostas ou expectativas de mock, cada uma terá sua própria URL de mock exclusiva.
Você pode clicar em Request para testar a URL de mock diretamente no Apidog.O botão Click to copy copia apenas a URL. Você deve adicionar manualmente o método HTTP e o corpo da requisição ao usar a URL em outro lugar.
Acessar mock dentro do Apidog#
Cada projeto do Apidog inclui ambientes de mock local e mock na nuvem no seletor de ambientes (canto superior direito).Ao selecionar um ambiente de mock, todas as requisições no Apidog são roteadas automaticamente para esse servidor de mock.Apenas endpoints com caminhos que começam com / serão enviados ao ambiente de mock. Endpoints com URLs completas (que não começam com /) não usarão o ambiente de mock.