Iniciar sesión

DTOs, JSON y versiones en Spring Boot

Qué sale en el JSON y cómo cambiar sin romper

Unidad: APIs REST Gratis
🧾
DTOs, JSON y versiones
Nunca respondas tal cual las clases con que tu app trabaja por dentro, como la que guardas en la base de datos (la entidad): podrías enviar datos privados, como una contraseña. Usa un DTO (objeto para transferir datos): un record con solo lo que el cliente debe ver. Si un campo no debe salir, @JsonIgnore lo quita del JSON.
record Cliente(String nombre, @JsonIgnore String password) { } // GET /clientes/1 → {"nombre":"Ana"}
El cliente dice qué formato quiere con la cabecera Accept; a esto se le llama negociación de contenido. Tu app sabe JSON; si alguien pide Accept: application/xml y no tienes cómo responder XML, Spring responde 406.
Al revés, la cabecera Content-Type dice en qué formato viene el cuerpo que se envía. Si un POST dice Content-Type: text/plain, Spring no lo lee como JSON y responde 415, aunque el texto sí sea un JSON.
Cuando una API cambia, los clientes viejos no deben romperse. Spring 7 trae versionado: el atributo version y una propiedad que dice dónde viene la versión, por ejemplo en la cabecera API-Version.
@GetMapping(path = "/menu", version = "1") String v1() { return "menu v1"; } @GetMapping(path = "/menu", version = "2") String v2() { return "menu v2"; } # application.properties spring.mvc.apiversion.use.header=API-Version spring.mvc.apiversion.default=1
Sin ninguna propiedad spring.mvc.apiversion.use.* (cabecera, parámetro de la URL…) la app no arranca, porque no sabe dónde leer la versión. Con default, quien no manda versión recibe la 1; sin él, recibe 400. Una versión que no existe también da 400. Para documentar tu API se usa OpenAPI (Swagger), que genera una página con todas las rutas.

Pon a prueba lo que aprendiste

Concepto

¿Para qué sirve un DTO en una API?

  1. APara que Spring encuentre tus controladores
  2. BPara guardar los pedidos en la base de datos
  3. CPara responder solo lo que el cliente debe ver
  4. DPara elegir el puerto de Tomcat
Ver respuesta
C) Para responder solo lo que el cliente debe ver El DTO es el contrato con el cliente, sin datos internos.
Trazar código

¿Qué cuerpo responde GET /clientes/1?

record Cliente(String nombre, @JsonIgnore String password) { } @GetMapping("/clientes/1") Cliente uno() { return new Cliente("Ana", "secreto123"); }
  1. A{"nombre":"Ana"}
  2. B{"nombre":"Ana","password":null}
  3. C{}
  4. D{"nombre":"Ana","password":"secreto123"}
Ver respuesta
A) {"nombre":"Ana"} @JsonIgnore quita el campo del JSON.
Trazar código

La app no tiene cómo escribir XML. Haces GET /precio con la cabecera Accept: application/xml. ¿Qué responde?

record Precio(String producto, int pesos) { } @GetMapping("/precio") Precio precio() { return new Precio("tacos", 15); }
  1. A406 Not Acceptable
  2. B200 con el JSON de todos modos
  3. C404 Not Found
  4. D200 con el mismo dato en XML
Ver respuesta
A) 406 Not Acceptable No puede darte el formato que pediste.

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.