Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .githooks/commit-msg
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")

PROJECT_KEY="PETCONTROL"

REGEX="^\[$PROJECT_KEY-[0-9]{3}\] (feat|hotfix|fix|test|docs|chore|refactor|build): .+"
REGEX="^\[$PROJECT_KEY(-M)?-[0-9]{3}\] (feat|hotfix|fix|test|docs|chore|refactor|build): .+"

if [[ ! $COMMIT_MSG =~ $REGEX ]]; then
echo "[ERROR] Invalid commit message format."
Expand Down
58 changes: 30 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 🐾 PetControl API

⛔ *Seção em construção*
O PetControl é uma API REST desenvolvida em Spring Boot para cadastro e gerenciamento de pets disponíveis para adoção. O sistema permite criar, listar, consultar, editar e remover pets, fornecendo uma arquitetura organizada, documentação interativa e integração com aplicações frontend.

<br>

🔗 API disponível em produção: [link](https://petcontrol-api-h7vz.onrender.com/actuator/health)
🔗 Disponível em produção (Swagger/OpenAPI): [https://petcontrol-api-h7vz.onrender.com/swagger-ui/index.html](https://petcontrol-api-h7vz.onrender.com/swagger-ui/index.html)

*⚠️ A aplicação pode levar alguns segundos para responder na primeira requisição devido ao cold start da plataforma.*

Expand All @@ -14,43 +14,45 @@

Este projeto possui uma interface web desenvolvida separadamente para consumo da API:

🔗 Frontend: [link](https://petcontrol-app.onrender.com)
🔗 Frontend (Produção): [https://petcontrol-app.onrender.com](https://petcontrol-app.onrender.com)

🔗 Repositório: [link](https://github.com/db-petcontrol/petcontrol-app)
🔗 Repositório: [https://github.com/db-petcontrol/petcontrol-app](https://github.com/db-petcontrol/petcontrol-app)


<br>

## ✨ Principais funcionalidade
⛔ *Seção em construção*
- Cadastro de pets com validação de dados
- Listagem paginada de pets ordenados por nome
- Visualização detalhada de um pet por ID
- Edição de informações de pets cadastrados
- Exclusão de pets
- Regras de validação para dados do pet (campos obrigatórios, caracteres válidos e tamanho)
- Testes unitários e de integração.

<br>

## 🛠️ Tecnologias utilizadas

### Backend
- ☕ Java 21 — linguagem principal da aplicação
- 🍃 Spring Boot — framework para API REST
- 💾 PostgreSQL — banco relacional principal
- 💾 H2 Database — banco em memória para testes e desenvolvimento
- 🔁 MapStruct — mapeamento entre DTOs e entidades
- 📦 Lombok — redução de boilerplate no código

### Infraestrutura & Build
- 🐳 Docker — containerização da aplicação e padronização do ambiente
- 🪽 Flyway — versionamento e controle de migrations do banco de dados
- ⚙️ GitHub Actions — automação de CI/CD (build, testes e validações)
- 🪝 Git Hooks — validações locais antes de commits (ex: lint e padrões de código)

### Qualidade de Código
- 🧪 JUnit — framework principal para testes unitários
- 🧪 Mockito — criação de mocks para testes isolados
- 📊 JaCoCo — análise e relatório de cobertura de testes
- 🧹 Checkstyle — validação de padrões de código seguindo boas práticas de estilo Java
- 🎨 Spotless — formatação automática do código baseada no Google Java Format

### Documentação
- 📄 Swagger / OpenAPI — documentação interativa e explorável da API REST
| Tecnologia | Categoria |
| ----------------- | ------------------------ |
| Java | Linguagem |
| Spring Boot | Framework |
| PostgreSQL | Banco de Dados |
| H2 Database | Banco em Memória |
| MapStruct | Mapeamento |
| Lombok | Redução de Boilerplate |
| Docker | Containerização |
| Flyway | Migrations |
| GitHub Actions | CI/CD |
| Git Hooks | Validações Locais |
| JUnit | Testes Unitários |
| Mockito | Mocking |
| JaCoCo | Cobertura de Testes |
| Checkstyle | Padronização de Código |
| Spotless | Formatação |
| Swagger / OpenAPI | Documentação da API REST |


<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
public record PetRequestDTO(
@Pattern(regexp = "^[\\p{L}\\s]+$", message = "The name must contain only letters and spaces")
@NotBlank(message = "Pet name must not be blank")
@Size(max = 20, message = "Pet name must be at most 20 characters long")
@Size(max = 64, message = "Pet name must be at most 64 characters long")
@Schema(description = "Nome do pet", example = "Lily")
String name,
@NotNull(message = "Specie ID must not be null")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ void shouldReturnBadRequestForInvalidRequest(PetRequestDTO invalidRequest) throw
static Stream<PetRequestDTO> invalidPetRequestsProvider() {
return Stream.of(
PetsFixture.requestDtoBuilder().name(null).build(),
PetsFixture.requestDtoBuilder().name("a".repeat(21)).build(),
PetsFixture.requestDtoBuilder().name("a".repeat(65)).build(),
PetsFixture.requestDtoBuilder().name("Rex@#%$!").build(),
PetsFixture.requestDtoBuilder().name("Rex123").build(),
PetsFixture.requestDtoBuilder().specieId(null).build(),
Expand Down
Loading