# alanerochaa/humanlink-api architecture

> Architecture diagram of the GitHub repository alanerochaa/humanlink-api, 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/humanlink-api
- Repository: https://github.com/alanerochaa/humanlink-api

## Overview

##### Identificação do Projeto
- Tipo: API RESTful em Java (Quarkus) para coordenação humanitária.
- Propósito: Expor endpoints para cadastro e consulta de usuários, voluntários, doações, áreas de desastre etc., persistindo dados em Oracle DB.

##### Análise da Estrutura
- Camadas típicas:
- Controllers em com.humanlink.controller
- Services em com.humanlink.service
- Repositories em com.humanlink.repository
- Models/Entities em com.humanlink.model
- DTOs em com.humanlink.DTOs
- Filtro de segurança em com.humanlink.security
- Exception handlers em com.humanlink.exception

##### Como desenhar um Diagrama UML Simples
- Mostre pacotes (packages) ou camadas agrupando classes por responsabilidade.

##### Componentes Principais (exemplo com “Usuário”)
a. UsuarioController «Controller»
b. UsuarioService    «Service»
c. UsuarioRepository «Repository»
d. Usuario           «Entity» (model)
e. UsuarioDTO        «DTO»

##### Relacionamentos
- Controller → Service: dependência (usa)
- Service → Repository: dependência (usa)
- Repository → Entity: associação (persistência)
- Controller → DTO: mapeamento de entrada/saída

##### Padrões e Estilo UML
- Caixas retangulares: classes, com nome, estereótipo («Controller», «Service», etc.).
- Setas sólidas com ponta aberta: “usa” ou “depende de”.
- Linhas simples com diamante vazio: associação (por ex. Repository → Entity).
- Agrupe em packages ou use cores:
- Azul para Controllers
- Verde para Services
- Laranja para Repositories
- Amarelo para Entities
- Cinza para DTOs

##### Exemplo de Código PlantUML
**@startuml**
**package "Controller" #LightBlue {**
- class UsuarioController <<Controller>> {
- getAll(): List<UsuarioDTO>
- create(u: UsuarioDTO): UsuarioDTO
- }
**}**
**package "Service" #LightGreen {**
- class UsuarioService <<Service>> {
- findAll(): List<Usuario>
- save(u: Usuario): Usuario
- }
**}**
**package "Repository" #Peach {**
- class UsuarioRepository <<Repository>> {
- findAll(): List<Usuario>
- save(u: Usuario): Usuario
- }
**}**
**package "Model" #LightYellow {**
- class Usuario <<Entity>> {
- id: Long
- nome: String
- email: String
- }
**}**
**package "DTO" #LightGray {**
- class UsuarioDTO <<DTO>> {
- nome: String
- email: String
- }
**}**

**UsuarioController --> UsuarioService**
**UsuarioService --> UsuarioRepository**
**UsuarioRepository --> Usuario**
**UsuarioController --> UsuarioDTO**
**@enduml**

##### Ajustes Finais
- Repita o padrão acima para outras entidades (Voluntario, Doacao, Relato, etc.).
- Inclua também o MyApiKeyFilter apontando para os Controllers.
- Adicione ExceptionHandlers em package separado, ligados aos Controllers.
- Utilize legendas ou cores para facilitar leitura.

Com essa base você terá um diagrama UML simples, claro e adaptado ao projeto HumanLink API.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Controller"
        UC[UsuarioController «Controller»]:::controller
    end

    subgraph "Service"
        US[UsuarioService «Service»]:::service
    end

    subgraph "Repository"
        UR[UsuarioRepository «Repository»]:::repository
    end

    subgraph "Model"
        U[Usuario «Entity»]:::entity
    end

    subgraph "DTO"
        UD[UsuarioDTO «DTO»]:::dto
    end

    subgraph "Security"
        F[MyApiKeyFilter «Filter»]:::security
    end

    subgraph "Exception Handlers"
        BR[BadRequestExceptionHandler]:::exception
        NF[NotFoundExceptionHandler]:::exception
        VE[ValidationExceptionHandler]:::exception
        RNF[RouteNotFoundException]:::exception
        EH[ExceptionHandler]:::exception
        BE[BadRequestException]:::exception
        NE[NotFoundException]:::exception
        RD[ResponseDTO]:::dto
    end

    F --> UC
    UC --> US
    US --> UR
    UR --> U
    UC --> UD

    UC --> BR
    UC --> NF
    UC --> VE
    UC --> RNF
    UC --> EH

    BR --> BE
    NF --> NE
    EH --> RD

    click UC "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/controller/UsuarioController.java"
    click US "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/service/UsuarioService.java"
    click UR "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/repository/UsuarioRepository.java"
    click U "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/model/Usuario.java"
    click UD "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/DTOs/UsuarioDTO.java"
    click F "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/security/MyApiKeyFilter.java"
    click BR "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/BadRequestExceptionHandler.java"
    click NF "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/NotFoundExceptionHandler.java"
    click VE "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/ValidationExceptionHandler.java"
    click RNF "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/RouteNotFoundException.java"
    click EH "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/ExceptionHandler.java"
    click BE "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/BadRequestException.java"
    click NE "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/NotFoundException.java"
    click RD "https://github.com/alanerochaa/humanlink-api/blob/main/src/main/java/com/humanlink/exception/dto/ResponseDTO.java"

    classDef controller fill:#ADD8E6,stroke:#000,stroke-width:1px;
    classDef service fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef repository fill:#FFDAB9,stroke:#000,stroke-width:1px;
    classDef entity fill:#FFFFE0,stroke:#000,stroke-width:1px;
    classDef dto fill:#D3D3D3,stroke:#000,stroke-width:1px;
    classDef security fill:#FFA07A,stroke:#000,stroke-width:1px;
    classDef exception fill:#F08080,stroke:#000,stroke-width:1px;
```
