Skip to content

FelipeRibeir0/ApiSpringBoot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


API SPRING BOOT
API de Gerenciamento de Produtos
(PRODUCTS-API)

Uma API RESTful desenvolvida com Spring Boot para gerenciamento de produtos. Essa aplicação foi projetada para operações básicas de CRUD (Create, Read, Update e Delete) utilizando Java 21, banco de dados MySQL e as melhores práticas do Spring Framework.


API Preview


🚀 Descrição Geral

Essa API permite:

  • Criar novos produtos no sistema.
  • Buscar todos os produtos ou um produto específico por ID.
  • Atualizar total ou parcialmente produtos existentes.
  • Excluir produtos do banco de dados.

Foi implementada usando Spring Data JPA para abstrair as operações de banco de dados e um banco persistente MySQL. A API é totalmente documentada no arquivo README e no Swagger.


🖥️ Configuração do Ambiente

Pré-requisitos

  • Java 21: Certifique-se de que está instalado e configurado no ambiente.
  • Maven: Necessário para gerenciar dependências e executar o projeto.
  • IDE recomendada: IntelliJ IDEA (opcional, mas recomendado para melhor produtividade).

Configuração Inicial

  1. Clone o repositório:

    git clone https://github.com/FelipeRibeir0/ApiSpringBoot.git
    cd ApiSpringBoot
    
  2. Execute o projeto:

    mvn spring-boot:run
  3. A API estará disponível em:

    http://localhost:8080
    
  4. Para acessar o console do banco de dados MySQL:

    mysql -u testeUsuarios -p
    • Usuário: testeUsuarios
    • Senha: (deixe vazio)

📄 Documentação da API

Este projeto disponibiliza uma API que pode ser acessada e testada diretamente através da documentação gerada pelo Swagger.

Acessando a documentação Swagger

Após rodar a aplicação, a documentação do Swagger estará disponível na seguinte URL: Swagger

Passos para acessar a documentação:

  1. Certifique-se de que o projeto está rodando localmente ou em um ambiente de desenvolvimento.
  2. Abra seu navegador e acesse a URL: http://localhost:8080/documentacao
  3. Você verá a interface gráfica do Swagger UI, onde poderá explorar todos os endpoints da API e fazer chamadas de teste diretamente pela interface.

🌐 Endpoints da API

Método Endpoint Descrição
GET /produtos Retorna a lista de todos os produtos. Aceita um parâmetro opcional de busca por nome.
GET /produtos/{id} Retorna os detalhes de um produto específico pelo ID.
POST /produtos Cria um novo produto no sistema.
PUT /produtos/{id} Atualiza completamente as informações de um produto existente.
PATCH /produtos/{id} Atualiza parcialmente as informações de um produto existente.
DELETE /produtos/{id} Exclui um produto do sistema pelo ID.

🛠️ Técnicas e Tecnologias Utilizadas

  • Spring Boot: Framework principal da aplicação.
  • Spring Data JPA: Gerenciamento de dados usando ORM.
  • Banco de Dados MySQL: Banco de dados persistente.
  • Java 21: Linguagem utilizada.

📂 Estrutura do Projeto

src
├── main/
│   ├── 📂 java/com/firstAPI/
│   │   ├── 📂 Controller        [Definições de rotas e lógica básica da API]
│   │   ├── 📂 Service           [Regras de negócio e validações]
│   │   ├── 📂 Model             [Modelos de dados (Entidades)]
│   │   ├── 📂 Repository        [Repositórios para abstração de acesso ao banco de dados]
│   └── 📂 resources/
│       └── 📂 static/ 

Considerações Finais

Esta API foi desenvolvida como um exemplo prático para quem está aprendendo Spring Boot. Ela é simples, funcional e facilmente extensível.

Possíveis melhorias futuras:

  • 🔒 Adicionar autenticação com JWT.
  • 🧪 Adicionar testes unitários e de integração.

About

API para testes e estudo feita utilizando Spring Boot

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages