# alanerochaa/quarkus-teste architecture

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

- Interactive diagram: https://gitdiagram.com/alanerochaa/quarkus-teste
- Repository: https://github.com/alanerochaa/quarkus-teste

## Overview

##### Projeto e Propósito
- Trata-se de uma aplicação backend Java usando o framework Quarkus.
- Fornece uma API REST para gerenciar entidades (Usuário, Tarefa, Notificação, etc.) seguindo a arquitetura em camadas (Controller → Service → Repository → Database).

##### Estrutura de Pastas (Pacotes)
- src/main/java/com/rail/response/system/controller
- src/main/java/com/rail/response/system/service
- src/main/java/com/rail/response/system/repository
- src/main/java/com/rail/response/system/model
- src/main/java/com/rail/response/system/response/system/DTOs
- src/main/java/com/rail/response/system/exception
- src/main/java/com/rail/response/system/security
- src/main/java/com/rail/response/system/util
- src/main/resources (configurações e scripts SQL)

##### Componentes Principais a Incluir no Diagrama UML
a. Pacotes (packages) que correspondem às pastas do projeto.
b. Classes dentro de cada pacote.
- controller: ContatoController, EquipeController, …, UsuarioController
- service: ContatoService, EquipeService, …, UsuarioService
- repository: ContatoRepository, EquipeRepository, …, UsuarioRepository
- model: BaseEntity, Contato, Equipe, …, Usuario
- DTOs: ContatoDTO, EquipeDTO, …, UsuarioDTO
- exception: BadRequestException, NotFoundException, ExceptionHandler, DTO de erro
- security: MyApiKeyFilter
- util: LoggerUtil, ValidatorUtils
c. Conector externo: Banco de dados SQL (baseado em application.properties e database_script.sql)

##### Relacionamentos e Interações
- Controllers → Services (dependência “uses”)
- Services → Repositories (dependência “uses”)
- Repositories → Model (mapeamento JPA)
- Controllers ↔ DTOs (conversão de payload)
- ExceptionHandlers (interceptam exceções lançadas em Controllers/Service)
- MyApiKeyFilter (filtra toda requisição HTTP antes de chegar nos Controllers)
- Database (entidade persistida pelos Repositories)

##### Padrões e Princípios Utilizados
- Arquitetura em camadas (Layered Architecture)
- Inversão de Dependência / Injeção de Dependência (Quarkus CDI)
- Pacotes bem isolados: controllers, services, repositories, models, DTOs, exceptions, util
- Tratamento global de exceções (ExceptionHandler)
- Filtro de segurança (API Key Filter)

##### Guia para Desenhar o Diagrama UML
b. Crie um pacote (package) para cada pasta do projeto.
c. Dentro de cada pacote, represente cada classe como um retângulo UML com nome e, opcionalmente, principais métodos/atributos.
d. Pinte ou estilize cada pacote com cores distintas (ex.: verde para controller, azul para service, roxo para repository, amarelo para model, laranja para DTOs, vermelho para exception, cinza para util, cinza-escuro para security).
e. Desenhe setas direcionais:
- Das classes Controller para as classes Service (“→” com rótulo «uses»)
- Das classes Service para as classes Repository
- Das classes Repository para as classes Model («maps to»)
- Associação de Controller ↔ DTO (pode ser nota “<request/response>”)
- Banco de dados como entidade externa conectada ao pacote repository («persists to»).
f. Inclua legendas: cores, tipos de relações (uses, maps to, filters).
g. Adicione um pequeno bloco para “Resources” indicando application.properties, log4j2.xml e scripts SQL como artefatos de configuração.

##### Detalhamento Essencial
- Cada classe nomeada dentro de seu pacote
- Dependências entre camadas bem evidentes
- Componente externo “Database” separado
- Componente “MyApiKeyFilter” interceptando requisIções
- Blocos de exceção mostrando as handlers globais

Com esses passos, você obterá um diagrama UML simples, porém completo, que reflete todas as pastas e classes do projeto Quarkus e a interação entre elas.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Controller Layer
    subgraph "Controller Layer"
        CtrlPkg["controller"]:::pkg_controller
        ContatoController["ContatoController"]:::controller
        EquipeController["EquipeController"]:::controller
        UsuarioController["UsuarioController"]:::controller
    end

    %% Service Layer
    subgraph "Service Layer"
        ServPkg["service"]:::pkg_service
        ContatoService["ContatoService"]:::service
        EquipeService["EquipeService"]:::service
        UsuarioService["UsuarioService"]:::service
    end

    %% Repository Layer
    subgraph "Repository Layer"
        RepoPkg["repository"]:::pkg_repository
        ContatoRepo["ContatoRepository"]:::repository
        EquipeRepo["EquipeRepository"]:::repository
        UsuarioRepo["UsuarioRepository"]:::repository
    end

    %% Model Layer
    subgraph "Model Layer"
        ModelPkg["model"]:::pkg_model
        BaseEntity["BaseEntity"]:::model
        Contato["Contato"]:::model
        Equipe["Equipe"]:::model
        Usuario["Usuario"]:::model
    end

    %% DTO Layer
    subgraph "DTOs Layer"
        DTOpkg["DTOs"]:::pkg_dto
        ContatoDTO["ContatoDTO"]:::dto
        EquipeDTO["EquipeDTO"]:::dto
        UsuarioDTO["UsuarioDTO"]:::dto
    end

    %% Exception Layer
    subgraph "Exception Layer"
        ExPkg["exception"]:::pkg_exception
        BadRequestException["BadRequestException"]:::exception
        NotFoundException["NotFoundException"]:::exception
        ExceptionHandler["ExceptionHandler"]:::exception
        subgraph "Exception DTO Subpackage"
            ExDtoPkg["exception/dto"]:::pkg_exception
            ErrorDTO["ErrorDTO"]:::exception
        end
    end

    %% Security Layer
    subgraph "Security Layer"
        SecPkg["security"]:::pkg_security
        MyApiKeyFilter["MyApiKeyFilter"]:::security
    end

    %% Util Layer
    subgraph "Util Layer"
        UtilPkg["util"]:::pkg_util
        LoggerUtil["LoggerUtil"]:::util
        ValidatorUtils["ValidatorUtils"]:::util
    end

    %% Resources
    subgraph "Resources"
        AppProps["application.properties"]:::resource
        LogConfig["log4j2.xml"]:::resource
        DbScript["database_script.sql"]:::resource
    end

    %% External Database
    Database(("Database")):::database

    %% Relationships
    ContatoController -->|uses| ContatoService
    EquipeController -->|uses| EquipeService
    UsuarioController -->|uses| UsuarioService

    ContatoService -->|uses| ContatoRepo
    EquipeService -->|uses| EquipeRepo
    UsuarioService -->|uses| UsuarioRepo

    ContatoRepo -->|maps to| Contato
    EquipeRepo -->|maps to| Equipe
    UsuarioRepo -->|maps to| Usuario

    ContatoController <-->|<request/response>| ContatoDTO
    EquipeController <-->|<request/response>| EquipeDTO
    UsuarioController <-->|<request/response>| UsuarioDTO

    MyApiKeyFilter -->|filters| controller
    ContatoRepo -->|persists to| Database
    EquipeRepo -->|persists to| Database
    UsuarioRepo -->|persists to| Database

    BadRequestException -.->|handled by| ExceptionHandler
    NotFoundException -.->|handled by| ExceptionHandler

    %% Click Events
    click CtrlPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/controller"
    click ServPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/service"
    click RepoPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/repository"
    click ModelPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/model"
    click DTOpkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/DTOs"
    click ExPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/exception"
    click ExDtoPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/exception/dto"
    click MyApiKeyFilter "https://github.com/alanerochaa/quarkus-teste/blob/main/src/main/java/com/rail/response/system/security/MyApiKeyFilter.java"
    click UtilPkg "https://github.com/alanerochaa/quarkus-teste/tree/main/src/main/java/com/rail/response/system/util"
    click AppProps "https://github.com/alanerochaa/quarkus-teste/blob/main/src/main/resources/application.properties"
    click LogConfig "https://github.com/alanerochaa/quarkus-teste/blob/main/src/main/resources/log4j2.xml"
    click DbScript "https://github.com/alanerochaa/quarkus-teste/blob/main/src/main/resources/database_script.sql"

    %% Styles
    classDef pkg_controller fill:#e0ffe0,stroke:#333,stroke-width:1px
    classDef controller fill:#a2fca2,stroke:#333,stroke-width:1px
    classDef pkg_service fill:#e0f4ff,stroke:#333,stroke-width:1px
    classDef service fill:#a2d5f2,stroke:#333,stroke-width:1px
    classDef pkg_repository fill:#f0e0ff,stroke:#333,stroke-width:1px
    classDef repository fill:#d8b2f2,stroke:#333,stroke-width:1px
    classDef pkg_model fill:#fff8d6,stroke:#333,stroke-width:1px
    classDef model fill:#f2e59e,stroke:#333,stroke-width:1px
    classDef pkg_dto fill:#fff0e0,stroke:#333,stroke-width:1px
    classDef dto fill:#f2b98e,stroke:#333,stroke-width:1px
    classDef pkg_exception fill:#ffe0e0,stroke:#333,stroke-width:1px
    classDef exception fill:#f28e8e,stroke:#333,stroke-width:1px
    classDef pkg_security fill:#dddddd,stroke:#333,stroke-width:1px
    classDef security fill:#999999,stroke:#333,stroke-width:1px
    classDef pkg_util fill:#f5f5f5,stroke:#333,stroke-width:1px
    classDef util fill:#cccccc,stroke:#333,stroke-width:1px
    classDef resource fill:#e0e0e0,stroke:#333,stroke-width:1px
    classDef database fill:#ffffcc,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
```
