Skip to content

[openaudit-search-api] Tratamento de erros padronizado (Error response) + não vazar detalhes sensíveis #15

Description

@4lessandrodev

Repo: openaudit-search-api

Tags: priority:medium type:feature area:api area:security

Visão geral

Padronizar respostas de erro para previsibilidade e segurança (sem stack traces em produção).

Contexto

Uma API robusta deve tratar erros de forma consistente e evitar vazamento de detalhes internos, caminhos de arquivo ou SQL bruto.

Descrição

Implementar handler global de erros:

  • Mapear erros comuns:
    • 400 (q inválido)
    • 404 (rota inexistente)
    • 429 (rate limit)
    • 500 (erro interno)
  • Resposta JSON mínima com:
    • error.code
    • error.message (genérica)
    • request_id

Logs internos podem ter detalhes (sem PII), mas response deve ser seguro.

Adicionar testes para cada erro.

Impacto

Melhora UX e segurança operacional. Reduz risco de exposição acidental de detalhes internos.

Referências

Definição de pronto

  • Handler global implementado
  • Erros mapeados retornam códigos corretos
  • request_id incluído em erros
  • Testes cobrindo erros mais comuns

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions