Códigos HTTP y Response Entity en APIs REST

Clase 15 de 23 • Curso de Java Spring Boot

Resumen

En el desarrollo backend, responder con el código HTTP adecuado es esencial para comunicar correctamente el resultado de cada petición en tu API. Esta práctica incrementa la claridad, profesionalismo y permite a clientes interpretar con precisión cada respuesta, conforme al estándar de la web.

¿Qué son los códigos HTTP y por qué son importantes?

Los códigos HTTP son valores numéricos estándar que indican el resultado de una petición entre un cliente y un servidor.

El 200 muestra que la solicitud fue exitosa.
El 201 indica que se creó un recurso nuevo.
El 400 señala una petición incorrecta.
El 404 se refiere a recursos no encontrados.
El 500 marca errores internos del servidor.

Utilizar estos códigos correctamente guía a quienes consumen tu API sobre lo que realmente ocurrió con cada solicitud. Así, tu backend envía respuestas precisas y profesionales.

¿Cómo personalizar las respuestas de una API con Response Entity?

Al emplear la clase Response Entity, se gana control total sobre el contenido y código de cada respuesta. Por ejemplo, al buscar una película por ID:

Si el recurso existe, se devuelve con un 200 y el JSON correspondiente.
Si el recurso no está, lo adecuado es responder con un 404.

Pasos clave en la implementación:

Cambia el tipo de retorno a ResponseEntity<MovieDTO> en el controlador.
Busca la entidad por su ID y almacénala en una variable.
Si el resultado es nulo, devuelve ResponseEntity.notFound().build().
Si existe, usa ResponseEntity.ok(movieDTO).

Este patrón permite respuestas claras, acordes a la lógica de negocio, y mejora la experiencia para quienes interactúan con tu API.

¿Cómo aplicar Response Entity para listas y otros métodos?

Cuando necesitas devolver listas u otro tipo de información, igual puedes beneficiarte de Response Entity:

Retorna ResponseEntity<List<MovieDTO>> en vez de solo una lista.
Usa ResponseEntity.ok(listaDePeliculas) para empaquetar la respuesta.

Esto fortalece la coherencia y manejo de errores en todos los endpoints, haciendo el código más mantenible y robusto.

¿Tienes dudas sobre códigos HTTP o el uso de Response Entity en tus proyectos? Comparte tus experiencias o preguntas para seguir aprendiendo juntos.

Leiber Bertel

student•

Holaa. Si quieres aprender más sobre los códigos HTTP, te comparto estos recursos divertidos: HTTP Status Dogs API - A dog image for every HTTP Status Code y HTTP Cats. Adjunto imagen de ejemplo :).

Will Carlo

student••

https://http.cat/ es un clásico :D

Brayan Diaz

student••

Holaa people, así cree mi método getMovieById:

Erick Martinez Diaz

student•

Código HTTP: Importancia de devolver el código correcto en las respuestas de la API.
- 200: Petición exitosa.
- 201: Recurso creado.
- 400: Petición inválida.
- 404: Recurso no encontrado.
- 500: Errores en el servidor.
ResponseEntity: Permite personalizar la respuesta de la API, incluyendo códigos HTTP y mensajes claros.
Mejora de la API: Comunicar de manera profesional lo que ocurre con cada petición, aumentando la claridad y la calidad del servicio.

Santiago Andres Castro Cruz

student•

Si consultamos la lista completa de peliculas y en esta tabla no hay datos entonces nos retornara "[]" con status 200, en su defecto pues funciono, pero hay un codigo 204 No Content que podria aplicarse en este caso, yo lo implemente de la siguiente manera:

public ResponseEntity<List<MovieDto>> getAll(){
        List<MovieDto> list= this.movieService.getAll();
        if(list == null || list.isEmpty() ){
            return ResponseEntity.noContent().build();
        }
        return ResponseEntity.ok(list);
    }

Alejandro Ramírez

teacher•

Muy buena alternativa, Santi! Tu implementación con 204 No Content es totalmente válida. De hecho, muchos la usan. Sin embargo, en la mayoría de APIs REST se prefiere devolver 200 OK con [], porque así el cliente (normalmente un framework de frontend) siempre recibe una lista y no tiene que hacer lógica extra.

Para ser prácticos: los dos son correctos, pero 200 con lista vacía suele ser lo más práctico y estándar. 🚀

Angie Leticia Gil Lopez

student•

Santiago de acuerdo con Alejandro, pero en este caso si el objetivo de es mostrar un registro de algo, no sería muy funcional dejar mapeado un 204, ese 204 es más útil cuando se esta creando algo un nuevo registro o eliminando...