# lcpsantos/api-rest-adopet architecture

> Architecture diagram of the GitHub repository lcpsantos/api-rest-adopet, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lcpsantos/api-rest-adopet
- Repository: https://github.com/lcpsantos/api-rest-adopet

## Overview

##### Project type and purpose
- This is a monolithic, full-stack back-end REST API written in Java 17 using Spring Boot 3.
- The service (“Adopet”) handles pet adoption workflows: tutor management, shelter (abrigo) management, pet catalog, adoption requests, approvals/rejections, and email notifications.

##### File structure
- Top-level:
- pom.xml / Maven wrapper: build & dependency management
- src/main/java/br/com/alura/adopet/api: the application root package
- src/main/resources/db/migration: Flyway SQL migration scripts (schema)
- src/main/resources/application.properties: configuration (DB URL, profiles)
- Package layout (layered architecture):
- controller: REST controllers (HTTP endpoints)
- dto: data transfer objects (request/response payloads)
- model: JPA entities (Abrigo, Pet, Tutor, Adocao, enums)
- repository: Spring Data JPA interfaces (CRUD + queries)
- service: business logic services (AbrigoService, PetService, AdocaoService, TutorService) plus auxiliary classes (CalculadoraProbabilidadeAdocao, EmailService)
- validacoes: validation pipeline for adoption requests (interfaces + implementations)
- constants / exception: shared messages and exception classes
- Test tree mirrors the main code to validate each layer.

##### README for additional insights
- Tech stack: Spring Boot, Hibernate (JPA), Flyway, PostgreSQL.
- No front-end here, but the API supports a Figma-designed UI.

##### Main components
a. Client / Consumer:
- Mobile or Web front-end (Figma prototype) consuming the REST API over HTTP(s).
b. API Layer:
- HTTP endpoints in AbrigoController, PetController, TutorController, AdocaoController.
c. Business Logic Layer (Services):
- AbrigoService, PetService, TutorService, AdocaoService
- CalculadoraProbabilidadeAdocao (computes adoption probability)
- EmailService (two implementations for dev vs. prod)
- Validation chain: ValidacaoSolicitacaoAdocao orchestrates multiple Validacao...Impl classes
d. Persistence Layer:
- Spring Data JPA Repositories (AbrigoRepository, PetRepository, TutorRepository, AdocaoRepository)
- JPA Entities mapped to tables created via Flyway migrations
e. Database:
- PostgreSQL instance — relational store for all entities
- Flyway manages schema versions V1–V4
f. External Services:
- SMTP/email provider (abstracted by EmailServiceProducao)

##### Relationships and data flow
1. Client → HTTP request → Controller
2. Controller → Request DTO → Service
3. Service invokes:
- Validation chain → throws ValidacaoException on failure
- Business logic / probability calculation
- Repository calls (CRUD operations)
- On adoption approval/rejection: triggers EmailService
4. Repository → JPA → SQL → PostgreSQL
5. Flyway (startup) → runs migrations → creates tables
6. EmailServiceProducao → SMTP server → sends real email

##### Architectural patterns and design principles
- Layered (Controller → Service → Repository → Database)
- Dependency injection (Spring @Service, @Repository, @Controller)
- Strategy/Chain of Responsibility in validation (`ValidacaoSolicitacaoAdocao` + `Validacao...Impl`)
- Template method for selecting EmailService implementation by Spring profile (dev vs. prod)
- Use of DTOs to decouple API contract from JPA entities

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Client
    Client["Client (Mobile/Web UI)"]:::external

    %% Web/API Layer
    subgraph "Web/API Layer"
        direction TB
        AbrigoController["AbrigoController"]:::api
        PetController["PetController"]:::api
        TutorController["TutorController"]:::api
        AdocaoController["AdocaoController"]:::api
    end

    %% Business/Service Layer
    subgraph "Business Service Layer"
        direction TB
        AbrigoService["AbrigoService"]:::business
        PetService["PetService"]:::business
        TutorService["TutorService"]:::business
        AdocaoService["AdocaoService"]:::business
        CalculadoraProbabilidadeAdocao["CalculadoraProbabilidadeAdocao"]:::business
        EmailService["EmailService (interface)"]:::business
        EmailServiceDev["EmailServiceDev"]:::business
        EmailServiceProducao["EmailServiceProducao"]:::business
        ValidacaoSolicitacaoAdocao["ValidacaoSolicitacaoAdocao"]:::business
        ValidacaoPetDisponivelImpl["ValidacaoPetDisponivelImpl"]:::business
        ValidacaoPetComAdocaoEmAndamentoImpl["ValidacaoPetComAdocaoEmAndamentoImpl"]:::business
        ValidacaoTutorComAdocaoEmAndamentoImpl["ValidacaoTutorComAdocaoEmAndamentoImpl"]:::business
        ValidacaoTutorComLimiteDeAdocoesImpl["ValidacaoTutorComLimiteDeAdocoesImpl"]:::business
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        direction TB
        AbrigoRepository["AbrigoRepository"]:::persistence
        PetRepository["PetRepository"]:::persistence
        TutorRepository["TutorRepository"]:::persistence
        AdocaoRepository["AdocaoRepository"]:::persistence
    end

    %% Database & Migrations
    subgraph "Database"
        direction TB
        Flyway["Flyway Migrations"]:::db
        PostgreSQL["PostgreSQL"]:::db
    end

    %% External Email SMTP
    SMTP["SMTP Server"]:::external

    %% Connections
    Client -->|"HTTP REST"| AbrigoController
    Client -->|"HTTP REST"| PetController
    Client -->|"HTTP REST"| TutorController
    Client -->|"HTTP REST"| AdocaoController

    AbrigoController -->|calls| AbrigoService
    PetController -->|calls| PetService
    TutorController -->|calls| TutorService
    AdocaoController -->|calls| AdocaoService

    AbrigoService -->|CRUD| AbrigoRepository
    PetService -->|CRUD| PetRepository
    TutorService -->|CRUD| TutorRepository
    AdocaoService -->|CRUD| AdocaoRepository

    AdocaoService -->|compute| CalculadoraProbabilidadeAdocao
    AdocaoService -->|validate| ValidacaoSolicitacaoAdocao
    ValidacaoSolicitacaoAdocao -->|chain| ValidacaoPetDisponivelImpl
    ValidacaoSolicitacaoAdocao -->|chain| ValidacaoPetComAdocaoEmAndamentoImpl
    ValidacaoSolicitacaoAdocao -->|chain| ValidacaoTutorComAdocaoEmAndamentoImpl
    ValidacaoSolicitacaoAdocao -->|chain| ValidacaoTutorComLimiteDeAdocoesImpl

    EmailServiceProducao -->|sends| SMTP

    AdocaoService -->|trigger| EmailService

    Flyway -->|initializes schema| PostgreSQL
    AbrigoRepository -->|JPA/SQL| PostgreSQL
    PetRepository -->|JPA/SQL| PostgreSQL
    TutorRepository -->|JPA/SQL| PostgreSQL
    AdocaoRepository -->|JPA/SQL| PostgreSQL

    %% Click Events
    click AbrigoController "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/controller/AbrigoController.java"
    click PetController "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/controller/PetController.java"
    click TutorController "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/controller/TutorController.java"
    click AdocaoController "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/controller/AdocaoController.java"
    click AbrigoService "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/AbrigoService.java"
    click PetService "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/PetService.java"
    click TutorService "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/TutorService.java"
    click AdocaoService "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/AdocaoService.java"
    click CalculadoraProbabilidadeAdocao "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/CalculadoraProbabilidadeAdocao.java"
    click EmailService "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/EmailService.java"
    click EmailServiceDev "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/EmailServiceDev.java"
    click EmailServiceProducao "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/service/EmailServiceProducao.java"
    click ValidacaoSolicitacaoAdocao "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/validacoes/ValidacaoSolicitacaoAdocao.java"
    click ValidacaoPetDisponivelImpl "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/validacoes/impl/ValidacaoPetDisponivelImpl.java"
    click ValidacaoPetComAdocaoEmAndamentoImpl "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/validacoes/impl/ValidacaoPetComAdocaoEmAndamentoImpl.java"
    click ValidacaoTutorComAdocaoEmAndamentoImpl "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/validacoes/impl/ValidacaoTutorComAdocaoEmAndamentoImpl.java"
    click ValidacaoTutorComLimiteDeAdocoesImpl "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/validacoes/impl/ValidacaoTutorComLimiteDeAdocoesImpl.java"
    click AbrigoRepository "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/repository/AbrigoRepository.java"
    click PetRepository "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/repository/PetRepository.java"
    click TutorRepository "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/repository/TutorRepository.java"
    click AdocaoRepository "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/java/br/com/alura/adopet/api/repository/AdocaoRepository.java"
    click Flyway "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/resources/db/migration/V1__create-table-abrigos.sql"
    click PostgreSQL "https://github.com/lcpsantos/api-rest-adopet/blob/master/src/main/resources/db/migration/V4__create-table-adocoes.sql"

    %% Styles
    classDef api fill:#D0E8FF,stroke:#0366d6,color:#0366d6
    classDef business fill:#E2F0D9,stroke:#228B22,color:#228B22
    classDef persistence fill:#FFE5B4,stroke:#FF8C00,color:#FF8C00
    classDef db fill:#EEEEEE,stroke:#666666,color:#333333
    classDef external fill:#F0E6FF,stroke:#800080,color:#800080
```
