Use o contrato do serviço
Os produtos da Lerian não compartilham um único envelope de erro nem um formato universal de códigos de erro. Para cada operação, use o schema de resposta e a referência de erros implementados por aquele serviço como fonte de verdade. Antes de tratar um erro programaticamente, verifique:
- O media type e o schema de resposta.
- Se o serviço expõe um código de erro estável.
- Os campos presentes para aquela operação e código de status.
- A orientação documentada de repetição ou correção.
Validação de campos
Alguns serviços retornam detalhes de validação por campo e outros usam uma forma de erro diferente. Documente esses detalhes somente quando estiverem presentes no contrato implementado da operação.
Códigos de erro
Prefixos, formatos numéricos e significados dos códigos de erro variam conforme o produto. Não infira o significado de um erro a partir de um código usado por outro serviço. Consulte a referência de erros específica do produto antes de agir sobre um código de erro.
Autoria da referência de API
Mantenha schemas de requisição, resposta e erro na especificação do serviço. Renderize as páginas de operações a partir dessa especificação, em vez de copiar um modelo de erro para a documentação manual de endpoints.