Bienvenidos al desafío de Spring Boot diseñado para los seguidores del canal. Este proyecto tiene como objetivo construir una API RESTful que gestione las reservas de un hotel, poniendo en práctica tus habilidades de programación en Java y Spring Boot.
Desarrollar una completa API RESTful usando Spring Boot para un sistema de reservas de hoteles que permita a los usuarios realizar, actualizar, cancelar y buscar reservas.
- Java Version: Utiliza Java como lenguaje de programación, puedes usar la version de java que te parezca mejor, aunque en el proyecto esta definido la version 17.
- Comentarios: Proporciona comentarios para explicar el propósito y la funcionalidad de tu código.
- Documentación: Donde sea adecuado, agrega comentarios Javadoc para documentar tus clases y métodos.
- Pruebas Unitarias: Utiliza JUnit para escribir pruebas unitarias para tus implementaciones.
- Herramientas: Para realizar estas pruebas puedes usar cualquier tipo de herramientas, ayuda o libreria que necesites.
- ¡Diviértete!: Siente libre de modificar el código cómo tu prefieras, no existe una única solución a los problemas, intenta resolverlos cómo creas conveniente.
A continuación, se detallan las tareas específicas para cada requisito funcional, utilizando la nomenclatura GIVEN-WHEN-THEN para clarificar las expectativas.
Registrar nuevas habitaciones con detalles como identificador, tipo y precio.
- GIVEN un administrador desea agregar una nueva habitación al sistema
- WHEN el administrador envía los detalles de la habitación (identificador, tipo, precio)
- THEN el sistema registra la nueva habitación y devuelve un mensaje de éxito.
Listar todas las habitaciones disponibles.
- GIVEN un usuario desea ver todas las habitaciones disponibles
- WHEN el usuario solicita la lista de habitaciones disponibles
- THEN el sistema devuelve una lista de todas las habitaciones disponibles.
Actualizar los detalles de las habitaciones.
- GIVEN un administrador desea actualizar los detalles de una habitación existente
- WHEN el administrador envía los nuevos detalles de la habitación (tipo, precio)
- THEN el sistema actualiza los detalles de la habitación y devuelve un mensaje de confirmación.
Permitir a los clientes crear reservas, incluyendo nombre, fechas de check-in y check-out, y habitación.
- GIVEN un cliente desea hacer una reserva en el hotel
- WHEN el cliente envía los detalles de la reserva (nombre del cliente, fechas de check-in y check-out, habitación)
- THEN el sistema registra la reserva y devuelve un mensaje de confirmación.
Cancelar reservas existentes.
- GIVEN un cliente desea cancelar una reserva existente
- WHEN el cliente envía la solicitud de cancelación para una reserva específica
- THEN el sistema cancela la reserva y devuelve un mensaje de confirmación.
Modificar las fechas de una reserva.
- GIVEN un cliente necesita cambiar las fechas de una reserva existente
- WHEN el cliente envía las nuevas fechas para la reserva
- THEN el sistema actualiza las fechas de la reserva y devuelve un mensaje de confirmación.
Listar todas las reservas, tanto activas como canceladas.
- GIVEN un usuario desea ver todas las reservas, incluyendo las activas y canceladas
- WHEN el usuario solicita la lista de reservas
- THEN el sistema devuelve una lista de todas las reservas con su estado.
Buscar habitaciones disponibles por fecha y tipo.
- GIVEN un cliente busca habitaciones disponibles para ciertas fechas y de un tipo específico
- WHEN el cliente envía las fechas y el tipo de habitación deseado
- THEN el sistema devuelve una lista de habitaciones que cumplen con los criterios.
Buscar reservas por nombre del cliente.
- GIVEN un usuario desea buscar reservas utilizando el nombre del cliente
- WHEN el usuario envía el nombre del cliente
- THEN el sistema devuelve una lista de reservas asociadas a ese nombre.
- Utilizar JPA (Java Persistence API) con la base de datos de tu elección para la persistencia de datos.
Desarrolla la API Rest siguiendo las prácticas RESTful. Define los endpoints para la gestión de habitaciones y reservas, asegurándote de que la API sea intuitiva y fácil de usar. Implementa los controladores, servicios y repositorios necesarios utilizando Spring Boot.
Escribe pruebas unitarias para tus servicios y repositorios. Asegúrate de cubrir casos de uso críticos y bordes para garantizar la calidad y fiabilidad de la aplicación. Utiliza frameworks como JUnit y Mockito para simular comportamientos y validar la lógica de negocio.
Desarrolla pruebas de integración para tus endpoints. Estas pruebas deben verificar que la API responde correctamente a las solicitudes HTTP y se integra adecuadamente con la base de datos. Utiliza TestRestTemplate o MockMvc para simular llamadas a la API.
Utiliza OpenAPI o Swagger para documentar tu API. Asegúrate de que cada endpoint esté correctamente descrito, incluyendo parámetros, formatos de respuesta y códigos de estado. Esta documentación servirá como una guía para los desarrolladores que utilicen tu API.
Configura la seguridad de tu aplicación utilizando Spring Security. Implementa autenticación básica para proteger los endpoints de la API. Asegúrate de que solo los usuarios autenticados puedan realizar operaciones sensibles como crear o cancelar reservas.
- Haz un fork de este repositorio
- Clona el repositorio fork en tu máquina local.
- Completa cada parte de la prueba siguiendo las instrucciones proporcionadas en cada archivo.
- Asegúrate de escribir pruebas unitarias para validar tu código.
- Añade cualquier comentario adicional o aclaración que consideres necesario.
- Al finalizar, puedes compartir tu solución en el Discord en el canal #Desafios para que otros también puedan verlo.