Usa el contrato del servicio
Los productos de Lerian no comparten un único envelope de error ni un formato universal de códigos de error. Para cada operación, usa el esquema de respuesta y la referencia de errores implementados por ese servicio como fuente de verdad. Antes de manejar un error programáticamente, verifica:
- El media type y el esquema de respuesta.
- Si el servicio expone un código de error estable.
- Los campos presentes para esa operación y código de estado.
- La guía documentada de reintento o remediación.
Validación de campos
Algunos servicios devuelven detalles de validación por campo y otros usan una forma de error diferente. Documenta esos detalles solo cuando estén presentes en el contrato implementado de la operación.
Códigos de error
Los prefijos, los formatos numéricos y los significados de los códigos de error varían según el producto. No infieras el significado de un error a partir de un código usado por otro servicio. Consulta la referencia de errores específica del producto antes de actuar sobre un código de error.
Creación de referencia de API
Mantén los esquemas de solicitud, respuesta y error en la especificación del servicio. Renderiza las páginas de operaciones a partir de esa especificación en lugar de copiar un modelo de error en documentación manual de endpoints.