APIs e dados

Como depurar respostas JSON de API

Formate a resposta, confirme o status HTTP, valide o schema e compare mudanças do payload antes de alterar código.

Bugs de resposta API costumam misturar dois problemas: o request não enviou o esperado ou o body não tem a forma que a aplicação espera.

Um workflow confiável separa transporte, sintaxe, schema e detecção de mudanças para encontrar a falha sem adivinhar.

Comece pelo request

Se o relatório inclui um comando cURL, analise-o primeiro. Revise método, URL, query parameters, headers, content type e body.

Authorization header errado, content type ausente, endpoint antigo ou query parameter alterado pode gerar JSON válido, mas incorreto.

Formate e valide a resposta

Pretty-print JSON para revisar objetos aninhados, arrays, nulls e strings escapadas com mais clareza.

Depois valide contra JSON Schema para detectar required fields ausentes, tipos errados, enums alterados e nested shapes inesperados.

Compare payloads antes e depois

Quando uma API muda após release, compare JSON antigo e novo lado a lado. Procure campos renomeados, wrappers novos, arrays removidos, IDs alterados e status diferentes.

Normalize o formato primeiro para o diff mostrar mudanças de dados, não whitespace.

Checklist de depuração JSON API

  • Analise o cURL copiado e confirme método, URL, headers e body.
  • Revise HTTP status e content type antes do body.
  • Formate a resposta JSON e remova dados privados antes de compartilhar.
  • Valide o payload contra o schema esperado.
  • Compare respostas antigas e novas quando release ou vendor change quebra comportamento.

Guias relacionados

Entenda o workflow por trás desta ferramenta e o que revisar depois.

Ferramentas relacionadas