How asobrados03/hotelmanagementapi works
Para representar con precisión la arquitectura de HotelManagementAPI, sigue estos pasos y recomendaciones, adaptados al propósito y estructura de este proyecto:
Identificación del tipo de proyecto y propósito
• Es una API RESTful de backend (monolito) construida en Java 21+ con Spring Boot.
• Aplica principios de “Clean Architecture” (arquitectura limpia / hexagonal) para separar la lógica de negocio, los adaptadores y la infraestructura.
Análisis de la estructura de archivos
• src/main/java/com/alfre/DHHotel/adapter:
• web/controller → Controladores REST (@RestController)
• web/dto → Objetos de entrada/salida (DTOs)
• persistence → Implementaciones JDBC de los repositorios (Adapter de Infraestructura)
• security/jwt → Filtros y servicios de JWT (Adaptador de Seguridad)
• src/main/java/com/alfre/DHHotel/usecase: Casos de uso (Orquestación de la lógica de negocio).
• src/main/java/com/alfre/DHHotel/domain:
• model → Entidades de dominio (Clientes, Reservas, Habitaciones, Usuarios…)
• repository → Interfaces (Puertos) para persistencia.
• src/main/java/com/alfre/DHHotel/config: Configuración de Spring, DataSource, Seguridad.
• resources: application.yml, openapi.yml, Docker Compose, SQL inicial para tests.
Puntos clave sacados del README
• Arquitectura hexagonal: clientes → adaptadores → casos de uso → dominio → adaptadores de persistencia → base de datos (MariaDB).
• JWT para autenticación/autorización.
• Contenedores Docker para MariaDB y Adminer.
• OpenAPI/Swagger para la documentación.
Cómo diseñar el diagrama de arquitectura
a. Componentes principales
1. Cliente (Front-end o Postman)
2. Controladores REST (@RestController)
3. DTOs (mapeo request/response)
4. Adaptador de Seguridad JWT (JwtAuthenticationFilter, JwtService)
5. Casos de Uso (usecase/*.java)
6. Entidades de Dominio y Puertos (domain/model + domain/repository)
7. Adaptador de Persistencia JDBC (adapter/persistence/*JdbcRepository)
8. Base de Datos MariaDB (contenedor Docker)
9. Adminer (contenedor Docker, UI de BD opcional)
10. Configuración Spring (DataSource, SecurityConfig)
b. Relaciones e interacciones
• Cliente —HTTP→ Controlador
• Controlador —mapea DTO→ Caso de Uso
• Adaptador de Seguridad intercepta todas las llamadas HTTP y llama a JwtService
• Caso de Uso —invoca→ Entidades y Puertos (interfaces)
• Puertos —implementados por→ Repositorios JDBC
• Repositorios JDBC —JDBC→ MariaDB
• Respuesta: flujo inverso hasta el Cliente
c. Patrones y principios arquitectónicos
• Arquitectura limpia / hexagonal (Ports & Adapters)
• Separación de capas: Adaptadores | Aplicación (Use Cases) | Dominio | Infraestructura
• Inversión de dependencias: la capa de dominio define interfaces, la infraestructura las implementa
d. Tecnologías y frameworks relevantes
• Spring Boot (MVC, Beans, Config)
• Spring Security + JWT
• JDBC puro (sin ORM)
• MariaDB en Docker
• Swagger/OpenAPI (openapi.yml)
• JUnit5, Mockito, Testcontainers para pruebas
Guía para el diagrama (orientado a una API backend full-stack por capas)
• Usa un diagrama de contenedores (nivel C2 del modelo C4) o un diagrama hexagonal:
• Dibujar un rectángulo grande “HotelManagementAPI” dividido en secciones horizontales o en anillos concéntricos:
– Front-end / Cliente
– Adaptadores (Web, DTO, Seguridad)
– Aplicación (Use Cases)
– Dominio (Modelos, Puertos)
– Infraestructura (Repositories, DB)
• Indicar el contenedor Docker de MariaDB y Adminer externamente.
• Mostrar la configuración de Spring como componente transversal (puede anotar Config en el diagrama).
Elementos gráficos recomendados
• Labels claros: nombre del componente y paquete principal (por ejemplo, “ReservationController (adapter.web.controller)”).
• Flechas direccionales:
• Flechas sólidas para llamadas sincrónicas (HTTP, método Java).
• Flechas punteadas para dependencias de configuración o inversión de control.
• Colores o formas distintas por capa:
• Adaptadores (azul), Use Cases (verde), Dominio (amarillo), Infraestructura (rojo), Externo (gris).
Herramientas y formato
• Exponer el diagrama en el README (PNG, SVG) o directamente en el Swagger-UI si la herramienta lo permite.
Nivel de detalle
• Incluye cada subpaquete principal (adapter.web.controller, adapter.security.jwt, usecase, domain.model, adapter.persistence).
• Detalla el flujo de autenticación JWT e identifica el filtro JwtAuthenticationFilter → JwtService → UserRepository.
• Señala que la persistencia usa JDBC puro y MariaDB dentro de Docker.
• No descartes el componente OpenAPI (openapi.yml) como parte de la documentación de la API.
Con estas indicaciones, tu diagrama capturará de forma exhaustiva la arquitectura limpia de HotelManagementAPI, reflejando tanto la capa de presentación (REST + seguridad) como la lógica de negocio, el dominio y la infraestructura de datos.