Iniciar sesión

ProblemDetail: errores estándar en Spring Boot

title, status, detail e instance

Unidad: Validación y manejo de errores Gratis
📋
ProblemDetail: errores estándar
Si cada API inventa su forma de error, cada cliente tiene que aprender una distinta. ProblemDetail es el formato estándar para responder errores, definido en el RFC 9457 (el documento oficial de internet que lo describe; reemplazó al RFC 7807), con campos fijos:
title resumen corto, como "Not Found" status el código, como 404 detail qué pasó en este caso instance la ruta que falló type enlace a la explicación (opcional)
En Spring, tu manejador puede devolver un ProblemDetail. Spring llena instance con la ruta y responde con Content-Type: application/problem+json.
@ExceptionHandler(PedidoNoEncontrado.class) ProblemDetail noExiste(PedidoNoEncontrado e) { return ProblemDetail.forStatusAndDetail( HttpStatus.NOT_FOUND, e.getMessage()); } // GET /pedidos/9 → 404 // {"detail":"No existe el pedido 9", // "instance":"/pedidos/9","status":404, // "title":"Not Found"}
Con setTitle cambias el título, y con setProperty agregas campos tuyos, como la lista de errores de validación:
pd.setTitle("Pedido inválido"); pd.setProperty("errores", lista);
Y si en application.properties pones spring.mvc.problemdetails.enabled=true, los errores de Spring también salen así: la validación fallida, una ruta que no existe o un ResponseStatusException. Ojo: en la validación el detail es genérico y en inglés («Invalid request content.»), sin decir qué campo falló; para eso sigues necesitando tu manejador.

Pon a prueba lo que aprendiste

Concepto

¿Qué es ProblemDetail?

  1. AUn archivo de log con los errores de la app
  2. BUn formato estándar para responder errores
  3. CUna excepción de Spring para errores 500
  4. DUna herramienta para buscar errores en el código
Ver respuesta
B) Un formato estándar para responder errores El RFC 9457, con title, status, detail e instance.
Trazar código

GET /pedidos/9 lanza new PedidoNoEncontrado(9) y el advice la atiende así. ¿Qué Content-Type trae la respuesta?

class PedidoNoEncontrado extends RuntimeException { PedidoNoEncontrado(int id) { super("No existe el pedido " + id); } } @RestControllerAdvice class ManejoDeErrores { @ExceptionHandler(PedidoNoEncontrado.class) ProblemDetail noExiste(PedidoNoEncontrado e) { return ProblemDetail.forStatusAndDetail( HttpStatus.NOT_FOUND, e.getMessage()); } }
  1. Aapplication/problem+json
  2. Btext/plain
  3. Capplication/json
  4. Dapplication/error+json
Ver respuesta
A) application/problem+json Así el cliente sabe que es un error estándar.
Trazar código

GET /pedidos/9 lanza new PedidoNoEncontrado(9) y el advice la atiende así. ¿Qué trae el campo instance?

class PedidoNoEncontrado extends RuntimeException { PedidoNoEncontrado(int id) { super("No existe el pedido " + id); } } @RestControllerAdvice class ManejoDeErrores { @ExceptionHandler(PedidoNoEncontrado.class) ProblemDetail noExiste(PedidoNoEncontrado e) { return ProblemDetail.forStatusAndDetail( HttpStatus.NOT_FOUND, e.getMessage()); } }
  1. A404, el código de estado
  2. B"/pedidos/9", la ruta que se pidió
  3. C"Not Found", el título del error
  4. D"No existe el pedido 9", el mensaje
Ver respuesta
B) "/pedidos/9", la ruta que se pidió Spring lo llena solo con la ruta.

Practica esta lección completa

Ejercicios de completar código, ordenar bloques y respuesta libre. Ganas XP y mantienes tu racha.

Practicar gratis, sin registrarte Entras como invitado directo a esta lección. Sin tarjeta.