Modelo editorial: este texto é um exemplo editável e não descreve um projeto executado.
Defina o contrato
Descreva quais campos entram, quais saem e quais regras precisam ser atendidas. Exemplos pequenos tornam a integração mais fácil de compreender.
Dê contexto aos erros
Uma resposta de erro deve ajudar o consumidor a corrigir a requisição. Evite expor dados internos e diferencie uma entrada inválida de uma falha de processamento.
Teste os limites
Além do caminho esperado, avalie campos ausentes, valores inválidos e dependências indisponíveis. Registre as decisões para facilitar a manutenção.