Documentação

Boas práticas e testes

Organização do código

Validação e erros

Valide formato na entrada e regras no domínio. Retorne erros claros por campo quando o cliente puder corrigir o dado. Respostas públicas não incluem stack trace, SQL, caminho interno ou segredo; detalhes técnicos ficam nos logs do projeto.

Banco

Use prepared statements, transações curtas, índices adequados e migrations reversíveis quando possível. Seeders precisam ser reproduzíveis e não podem duplicar dados a cada execução.

Matriz mínima de testes

ÁreaCenários obrigatórios
RotasMétodo, caminho inexistente, payload válido e inválido.
SegurançaSem token, token inválido, outro projeto e papel insuficiente.
BancoMigration, seeder, transação, conflito e rollback.
ConcorrênciaIdempotência, corrida e limites.
RuntimeHealth, catálogo de rotas e atualização incremental.

Antes de ativar

  1. Sincronize dependências.
  2. Execute análise e testes.
  3. Rode migrations e seeders necessários.
  4. Confira CORS e proteção das rotas.
  5. Teste respostas de sucesso e erro.
  6. Prepare rollback para mudanças de dados.