Guia prático

Como validar JSON em testes de API

Veja uma abordagem prática para conferir estrutura, tipos, campos obrigatórios e mensagens de erro.

JSON é o formato mais comum em APIs HTTP. Uma validação útil vai além de comparar todo o texto da resposta, pois ordem de propriedades e valores dinâmicos podem variar.

Valide em camadas

  1. Status e headers: confirme código HTTP, tipo de conteúdo e correlação.
  2. Estrutura: confira objetos, arrays e campos obrigatórios.
  3. Tipos: diferencie número, string, booleano e valor nulo.
  4. Regras: valide domínio, limites, formatos e relações entre campos.

Evite asserções frágeis

Comparar o JSON completo pode falhar quando surge um campo novo ou quando um timestamp muda. Valide exatamente o que representa o requisito, mantendo verificações de schema para o contrato geral.

Mensagens de erro também são contrato

Em cenários negativos, confira código interno, descrição útil e ausência de dados sensíveis. Uma API não deve devolver stack trace ou detalhes de infraestrutura ao consumidor.

Dica: formate a resposta durante a investigação, mas mantenha logs protegidos para não registrar tokens e dados pessoais.

Ferramentas relacionadas

Use os utilitários do QA Tools para preparar exemplos e verificar formatos diretamente no navegador.

Ver ferramentas