🐶🐾 Gerenciador de Adoção de Animais 🐾🐱

Este projeto é uma API Java que visa facilitar o gerenciamento de adoção de animais. Com esta API, é possível realizar diversas operações essenciais no contexto de adoção de animais, incluindo o cadastro de novos animais, a listagem detalhada ou filtrada, a atualização de informações e a exclusão de registros. Além disso, a API oferece a funcionalidade de adicionar comentários aos perfis dos animais, enriquecendo a interação e fornecendo uma plataforma aberta para expressar pensamentos e informações relevantes.

Tecnologias Utilizadas

🛠️ Java 11
🛠️ Spring Boot
🛠️ Spring Data JPA
🛠️ PostgreSQL
🛠️ Lombok
🛠️ Swagger (documentação da API)

Estrutura do Projeto

Pacotes

📚 controller: Contém os controladores responsáveis por lidar com as requisições HTTP.
📚 exception: Tratamento de exceções personalizado.
📚 model: Definição das entidades do banco de dados.
📚 repository: Interfaces para acesso aos dados no banco.
📚 service: Lógica de negócios e manipulação dos dados.

Funcionalidades

Cadastro de Animal
📋 Endpoint: /animais
📋 Método: POST
📋 Descrição: Cadastra um novo animal para adoção.
📋 Parâmetros: JSON contendo informações do animal.

Listagem de Animais
📋 Endpoint: /animais
📋 Método: GET
📋 Descrição: Lista todos os animais ou filtra por nome ou tamanho.
📋 Parâmetros: Nome (nome), Tamanho (tamanho), Página (page), e Tamanho da Página (size).

Busca por ID
📋 Endpoint: /animais/{id}
📋 Método: GET
📋 Descrição: Busca um animal pelo ID.

Atualização de Informações do Animal
📋 Endpoint: /animais/{id}
📋 Método: PATCH
📋 Descrição: Atualiza as informações de um animal pelo ID.
📋 Parâmetros: ID do animal (id), e JSON contendo as informações atualizadas.

Exclusão de Animal
📋 Endpoint: /animais/{id}
📋 Método: DELETE
📋 Descrição: Deleta um animal pelo ID.

Adição de Comentário a um Animal
📋 Endpoint: /animais/{id}/comentarios
📋 Método: POST
📋 Descrição: Adiciona um comentário a um animal pelo ID.
📋 Parâmetros: ID do animal (id), e JSON contendo o texto do comentário.

Listagem de Comentários de um Animal
📋 Endpoint: /animais/{id}/comentarios
📋 Método: GET
📋 Descrição: Lista todos os comentários de um animal pelo ID.

Documentação da API

📖 A documentação da API pode ser acessada através do Swagger. Após a execução do projeto, acesse http://localhost:8080/swagger-ui.html para explorar os endpoints e testar as operações.

Como Executar o Projeto

▶️ Certifique-se de ter o Java 11 e o PostgreSQL instalados.
▶️ Clone o repositório.
▶️ Configure as propriedades do banco de dados no arquivo application.properties.
▶️ Execute o projeto utilizando sua IDE favorita ou através do Maven: ./mvnw spring-boot:run.
▶️ Pronto! O projeto estará rodando em http://localhost:8080.

Contato

🤝 Linkedin

Feito com ❤️ por Thaís Braga Breder