How alanerochaa/humanlink-api works
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.