# adriaabf04/hotel-adri architecture

> Architecture diagram of the GitHub repository adriaabf04/hotel-adri, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/adriaabf04/hotel-adri
- Repository: https://github.com/adriaabf04/hotel-adri

## Overview

A continuación se detalla cómo abordar y plasmar el diagrama de diseño del sistema para este proyecto de gestión hotelera, el cual es una API RESTful desarrollada en Java usando Spring Boot.

##### Proyecto y Propósito
- Se trata de una API para la gestión de hoteles. El sistema permite gestionar reservas, habitaciones, pagos, clientes y administradores.
- El README especifica funcionalidades CRUD para cada entidad (Clientes, Habitaciones, Reservas, Pagos, Administradores) y destaca consideraciones de seguridad, validación, documentación (Swagger/OpenAPI) y pruebas.

##### Componentes y Capas Identificadas en el File Tree
- Capa de Presentación/API:
- Ubicada en los paquetes “controller” (AdminController, BookingController, ClientController, PaymentController, RoomController) que definen los endpoints REST.
- Capa de Servicio:
- Implementada en el paquete “service” (AdminService, BookingService, ClientService, PaymentService, RoomService, CustomUserDetailsService) que contiene la lógica de negocio.
- Capa de Persistencia:
- Representada por el paquete “repository” (IAdminRepository, IBookingRepository, IClientRepository, IPaymentRepository, IRoomRepository) que interactúa con el ORM (posiblemente JPA/Hibernate).
- Modelo y DTOs:
- Los paquetes “model” y “dto” definen las entidades y los objetos de transferencia de datos, respectivamente.
- Configuración y Seguridad:
- El paquete “config” contiene la configuración de seguridad (SecurityConfig) y también la configuración de Swagger (SwaggerConfig) para la documentación.
- Configuración de la aplicación en “src/main/resources/application.properties” y scripts de construcción y packaging (pom.xml, mvnw) indicados en el file tree.

##### Relaciones e Interacciones
- Los Controllers reciben y validan solicitudes REST.
- Los Controllers llaman a los Services, que contienen reglas de negocio e interactúan con las Repositories.
- Las Repositories se comunican con la base de datos mediante JPA/Hibernate.
- Los DTO se utilizan para encapsular y transferir datos entre las diferentes capas.
- La SecurityConfig establece la autenticación y autorización, restringiendo la creación, actualización o eliminación de recursos, y se apoya en el CustomUserDetailsService.
- SwaggerConfig se encarga de exponer la documentación interactiva de la API.

##### Patrones y Tecnologías
- Arquitectura de capas: separación clara entre controladores, servicios, repositorios y modelos.
- Uso de DTOs para desacoplar la capa de presentación de la capa de dominio.
- Configuración centralizada de seguridad (JWT o similar) para los administradores.
- Documentación con Swagger/OpenAPI.
- Test unitarios y de integración en “src/test” permiten validar funcionalidades.
- Tecnologías: Java, Spring Boot, JPA/Hibernate, posiblemente una base de datos relacional (MySQL, PostgreSQL, etc.).

##### Directrices para el Diagrama
a. Incluir cada una de las siguientes capas/componentes:
- Usuarios/Administradores (con autenticación y roles).
- Endpoints API (Controllers).
- Lógica de Negocio (Services).
- Acceso a Datos (Repositories y Modelos).
- Configuración de Seguridad y Documentación (SecurityConfig y SwaggerConfig).
- Base de datos (externa) como componente persistente.
b. Utilizar flechas direccionales para representar el flujo:
- Los clientes hacen peticiones a los Controllers.
- Los Controllers invocan los Services.
- Los Services utilizan las Repositories para acceder o modificar datos en la base de datos.
c. Incorporar notaciones de seguridad (p.ej., un apartado resaltado que muestre el proceso de autenticación y autorización para las rutas protegidas).
d. Utilizar colores o formas diferentes para distinguir entre:
- La capa de presentación (por ejemplo, cajas rectangulares para Controllers).
- La capa de persistencia (puedes representar la base de datos con un cilindro o un icono de base de datos).
- Configuraciones especiales (Swagger y Seguridad pueden destacarse con colores diferentes).

##### Instrucciones Prácticas para la Creación del Diagrama
- Empezar por esbozar la API y divídela en módulos: Clientes, Habitaciones, Reservas, Pagos y Administradores.
- Dibujar cajas para cada uno de los Controllers, conectándolas a sus respectivas capas de Service.
- Añadir las cajas de Service, enlazándolas a los Repositories que a su vez se conectan a la base de datos.
- Representar el flujo de datos: de la solicitud del cliente, pasando por autenticación (configurada en SecurityConfig) y luego la invocación del método en el servicio hasta la persistencia.
- Incluir anotaciones o leyendas que expliquen cada parte del diagrama.
- Agregar una sección para Swagger/OpenAPI que muestre que se proporciona documentación interactiva.

En resumen, el diagrama de arquitectura debe capturar los siguientes elementos:
- Componentes etiquetados (Controllers, Services, Repositories, Configuraciones, Seguridad).
- Relaciones y flujos de datos (usando flechas direccionales).
- Diferenciación visual (colores o formas) de cada tipo de componente.
- Especificación de tecnologías clave (Spring Boot, JPA/Hibernate, base de datos relacional, Swagger/OpenAPI).

Al seguir estas instrucciones, el diagrama resultante será un reflejo preciso y detallado de la arquitectura del proyecto, facilitando así la comprensión del sistema para el equipo de desarrollo y demás partes interesadas.

## Diagram (Mermaid)

```mermaid
flowchart TD

    %% Client Layer
    USR["User (Client/Administrator)"]:::client

    %% Configuration Layer
    subgraph "Configuration Layer"
        CONFIG["SecurityConfig & SwaggerConfig"]:::config
        APPCONFIG["Application Properties"]:::config
        SWAGGER["Swagger/OpenAPI Documentation"]:::config
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        CONTROLLERS["REST Controllers (Admin,Booking,Client,Payment,Room)"]:::controllers
    end

    %% Business Layer
    subgraph "Business Layer"
        SERVICES["Business Services (Admin,Booking,Client,Payment,Room,CustomUserDetailsService)"]:::services
    end

    %% Data Layer
    subgraph "Data Layer"
        REPOSITORIES["Repositories (IAdmin,IBooking,IClient,IPayment,IRoom)"]:::repositories
        MODELS["Domain Models"]:::models
        DTOS["DTOs"]:::dtos
    end

    %% Database Component
    DB["Database (Relational)"]:::database

    %% Connections
    USR -->|"sendsRequest"| CONFIG
    CONFIG -->|"verifiesAuth"| CONTROLLERS
    CONTROLLERS -->|"invokes"| SERVICES
    SERVICES -->|"accesses"| REPOSITORIES
    REPOSITORIES -->|"persistsData"| DB
    REPOSITORIES -->|"mapsTo"| MODELS
    MODELS -->|"transfersData"| DTOS
    CONFIG ---|"exposes"| SWAGGER

    %% Click Events
    click CONTROLLERS "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/controller"
    click SERVICES "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/service"
    click REPOSITORIES "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/repository"
    click MODELS "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/model"
    click DTOS "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/dto"
    click CONFIG "https://github.com/adriaabf04/hotel-adri/tree/main/src/main/java/com/example/hoteladri/config"
    click APPCONFIG "https://github.com/adriaabf04/hotel-adri/blob/main/src/main/resources/application.properties"

    %% Styles
    classDef client fill:#FFB6C1,stroke:#000,stroke-width:1px;
    classDef controllers fill:#ADD8E6,stroke:#000,stroke-width:1px;
    classDef services fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef repositories fill:#FFFF99,stroke:#000,stroke-width:1px;
    classDef models fill:#D3D3D3,stroke:#000,stroke-width:1px;
    classDef dtos fill:#E6E6FA,stroke:#000,stroke-width:1px;
    classDef config fill:#FFA07A,stroke:#000,stroke-width:1px;
    classDef database fill:#F5DEB3,stroke:#000,stroke-width:1px;
```
