Testar um endpoint de API uma vez é simples. Você envia uma requisição, revisa a resposta e confirma que tudo funciona como esperado. O verdadeiro desafio começa quando você precisa executar o mesmo teste em dezenas – ou mesmo centenas – de diferentes conjuntos de dados. Atualizar parâmetros manualmente e enviar requisições repetidamente não é apenas demorado, mas também propenso a erros e impossível de escalar.
É aqui que o teste de API orientado a dados entra em jogo. Em vez de reescrever ou reenviar requisições manualmente, você define um único caso de teste e o executa automaticamente com múltiplos conjuntos de dados de entrada. O resultado é uma cobertura mais ampla, maior precisão e muito menos esforço manual.
Para fazer isso de forma eficiente, você precisa da ferramenta certa. O Apidog se destaca por oferecer suporte nativo para testes orientados a dados usando arquivos CSV e JSON. Como uma plataforma completa de desenvolvimento e teste de API, o Apidog permite vincular arquivos de dados externos a um cenário de teste e executá-lo repetidamente, validando cada resposta automaticamente.
Seja para testar fluxos de login com diferentes usuários, APIs de busca com consultas variadas ou criação de recursos com múltiplas combinações de parâmetros, o Apidog elimina o trabalho repetitivo e ajuda você a obter testes de API confiáveis e abrangentes em uma fração do tempo.
Agora, vamos mergulhar em um guia completo e passo a passo para dominar o teste de API orientado a dados usando o Apidog com CSV e JSON.
Guia Passo a Passo para Teste de API Orientado a Dados com CSV e JSON
Vamos percorrer todo o processo, da configuração à execução, usando um exemplo concreto. Testaremos um endpoint de API de registro de usuário.
Passo 1: Defina Sua Requisição Base de API
Primeiro, você cria a requisição de API que servirá como seu modelo de teste.
- No Apidog, crie uma nova requisição para o seu endpoint de registro de usuário (ex:
POST /api/v1/users). - Configure os cabeçalhos (ex:
Content-Type: application/json). - Na aba Body, crie seu payload JSON. Em vez de codificar valores diretamente, você usará a sintaxe de variáveis dinâmicas
{{}}do Apidog para criar placeholders.
{
"username": "{{username}}",
"email": "{{email}}",
"password": "{{password}}",
"role": "{{role}}"
}
Observe os placeholders: {{username}}, {{email}}, etc. O Apidog os substituirá por valores reais do seu arquivo de dados durante a execução.
Passo 2: Crie Seu Arquivo de Dados de Teste (CSV ou JSON)
Agora, crie o arquivo externo que alimentará os dados em seus placeholders.
Opção A: Usando um Arquivo CSV
CSV é perfeito para dados tabulares. Crie um arquivo user_data.csv:
username,email,password,role,expected_status
john_doe,john@example.com,SecurePass123!,user,201
jane_smith,jane@example.com,AnotherPass456!,admin,201
bad_user,not-an-email,short,user,400
duplicate_user,john@example.com,SomePass789!,user,409- A primeira linha define os nomes das variáveis que correspondem aos seus placeholders (
username,email, etc.), além de umexpected_statusextra para validação. - Cada linha subsequente é um caso de teste com os dados para aquela execução.
Opção B: Usando um Arquivo JSON
JSON é ideal para estruturas de dados aninhadas ou mais complexas. Crie um arquivo user_data.json:
[
{
"username": "john_doe",
"email": "john@example.com",
"password": "SecurePass123!",
"role": "user",
"expected_status": 201
},
{
"username": "jane_smith",
"email": "jane@example.com",
"password": "AnotherPass456!",
"role": "admin",
"expected_status": 201
},
{
"username": "bad_user",
"email": "not-an-email",
"password": "short",
"role": "user",
"expected_status": 400
}
]
Passo 3: Configure o Teste Orientado a Dados no Apidog
É aqui que o fluxo de trabalho integrado do Apidog se destaca.
- Vá para a aba "Test" (Teste) dentro do seu painel (ou crie um novo caso de teste em um pacote de testes).
2. Clique para adicionar uma nova etapa de teste e selecione sua requisição POST /api/v1/users.
3. Carregar dados de teste: Clique em "Test Data" (Dados de Teste) > "+New" (Novo) para carregar seu arquivo user_data.csv ou user_data.json. O Apidog o analisará e mostrará uma prévia das linhas de dados.
4. Mapear Variáveis (se necessário): O Apidog mapeia automaticamente os nomes das colunas (CSV) ou chaves de propriedade (JSON) para os placeholders {{variable}} em sua requisição. Verifique se o mapeamento está correto.
Passo 4: Escreva Asserções Usando Suas Variáveis de Dados
O verdadeiro poder vem da validação de resultados esperados diferentes com base nos seus dados de entrada. Na aba Test (Teste), você escreve asserções (também chamadas de "asserts" ou "verificações").
Crucialmente, você pode referenciar as mesmas variáveis de dados do seu arquivo em suas asserções.
Por exemplo, adicione uma asserção de Código de Status da Resposta:
- Valor Esperado:
{{expected_status}}
Isso significa: "Para a primeira execução do teste (john_doe), afirme que o código de status é igual a 201. Para a terceira execução (bad_user), afirme que é igual a 400." A asserção muda dinamicamente a cada iteração.
Você pode adicionar asserções mais complexas usando JavaScript na seção Script do Apidog:
// Exemplo: Validar corpo da resposta para criação bem-sucedida
pm.test("Status code is " + pm.variables.get("expected_status"), function () {
pm.response.to.have.status(pm.variables.get("expected_status"));
});
// Apenas verifica o ID do usuário se esperamos uma criação bem-sucedida
if (pm.variables.get("expected_status") === 201) {
pm.test("Response has user ID", function () {
var jsonData = pm.response.json();
pm.expect(jsonData.id).to.be.a('number');
pm.expect(jsonData.username).to.eql(pm.variables.get("username"));
});
}
Passo 5: Execute o Teste e Analise os Resultados
Clique no botão Run (Executar). O Apidog executará sua única etapa de teste várias vezes, uma para cada linha em seu arquivo de dados.
O Relatório é Onde Tudo se Conecta:
O Apidog apresenta um relatório claro e agregado mostrando:
- Total de Iterações: (ex: "4/4 Passaram")
- Um detalhamento para cada linha de dados: Você pode expandir para ver a requisição exata enviada (com os valores reais substituídos) e a resposta recebida para aquela iteração específica.
- Quaisquer falhas são apontadas para a linha específica de dados que causou o problema. O
duplicate_userfalhou porque o status não era409? Você verá isso instantaneamente.
Isso torna a depuração incrivelmente eficiente. Você não precisa adivinhar qual caso de teste falhou; você sabe que foi a iteração com o conjunto de dados específico {"username": "duplicate_user", ...}.
Melhores Práticas para Teste de API Orientado a Dados
- Dados Específicos do Ambiente: Combine testes orientados a dados com os Environments (Ambientes) do Apidog. Você pode ter uma variável
base_urlem seu ambiente que muda de staging para produção, enquanto seu arquivo CSV contém os casos de teste aplicáveis a ambos. - Dados de Teste Reutilizáveis: Armazene seus arquivos CSV/JSON em um local central dentro do seu projeto Apidog. Vários pacotes de teste podem referenciar o mesmo arquivo de dados, garantindo consistência.
- Gere Arquivos de Dados Programaticamente: Para cenários complexos, use um script (Python, Node.js) para gerar seu arquivo
test_data.csv. Isso é excelente para testar com dados aleatórios ou uma grande variedade de valores (ex: testar paginação com 100 diferentes combinações depageelimit). - Configuração/Limpeza do Teste: Use os scripts de pré-requisição e os recursos de teardown de teste do Apidog em conjunto com testes orientados a dados. Por exemplo, antes de cada iteração de um teste
DELETE, você poderia usar um script de pré-requisição para criar o recurso que será excluído.
Conclusão: Transforme Seu Fluxo de Trabalho de Teste de API
O teste orientado a dados no Apidog com arquivos CSV/JSON o move da verificação manual e repetitiva para a validação automatizada e abrangente. Ele incorpora o princípio central de um bom teste: ser completo sem sacrificar a eficiência.
Ao externalizar seus dados de teste, você cria um documento vivo de cenários de teste que é fácil para qualquer membro da sua equipe ler, atualizar e entender. A integração perfeita dessa metodologia no Apidog significa que não há configuração complexa — apenas um caminho direto para APIs mais confiáveis.
Pare de testar APIs um caso de cada vez. Baixe o Apidog gratuitamente hoje, importe seu primeiro arquivo CSV e experimente o quão poderoso e eficiente o teste de API realmente pode ser.