diff --git a/.githooks/commit-msg b/.githooks/commit-msg index 7b786b3..81f1fc1 100644 --- a/.githooks/commit-msg +++ b/.githooks/commit-msg @@ -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." diff --git a/README.md b/README.md index e6a15eb..270cf06 100644 --- a/README.md +++ b/README.md @@ -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.
-šŸ”— 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.* @@ -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)
## ✨ 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.
## šŸ› ļø 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 | +
diff --git a/src/main/java/br/com/db/petcontrol/dto/request/PetRequestDTO.java b/src/main/java/br/com/db/petcontrol/dto/request/PetRequestDTO.java index bd3f295..b6ee884 100644 --- a/src/main/java/br/com/db/petcontrol/dto/request/PetRequestDTO.java +++ b/src/main/java/br/com/db/petcontrol/dto/request/PetRequestDTO.java @@ -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") diff --git a/src/test/java/br/com/db/petcontrol/controller/PetsControllerTest.java b/src/test/java/br/com/db/petcontrol/controller/PetsControllerTest.java index 8530071..745d3cd 100644 --- a/src/test/java/br/com/db/petcontrol/controller/PetsControllerTest.java +++ b/src/test/java/br/com/db/petcontrol/controller/PetsControllerTest.java @@ -298,7 +298,7 @@ void shouldReturnBadRequestForInvalidRequest(PetRequestDTO invalidRequest) throw static Stream 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(),