How lcpsantos/api-rest-adopet works
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