Cinco formatos de resposta que quebram aplicações. Descubra quais são e como evitar.
ERRADO: retornar valores como strings quando deveriam ser números ou booleanos. CERTO: definir schema rigoroso com tipos explícitos em JSON Schema ou OpenAPI.
ERRADO: um endpoint retorna array, outro retorna objeto, outro null. CERTO: padronizar sempre um wrapper consistente, mesmo para casos vazios.
ERRADO: omitir campo quando não existe, forçando o cliente a verificar presença. CERTO: incluir campo com null ou valor padrão explícito sempre.
ERRADO: respostas com 5+ níveis de objetos aninhados, parsing complexo. CERTO: achatar estrutura, usar IDs para relacionamentos, documentar claramente.
ERRADO: mudar estrutura sem avisar, quebra retrocompatibilidade. CERTO: usar versão na URL ou header, deprecar gradualmente, comunicar mudanças.
ERRADO: docs mostram um formato, API retorna outro. CERTO: gerar docs automaticamente do schema, testar exemplos continuamente.
Use ferramentas como Postman, Swagger/OpenAPI ou testes automatizados. Documente cada campo. Versionize suas APIs. Evite bugs antes que cheguem à produção.
Leia a matéria completa