A Baozi Store API é um sistema de back-end robusto para gerenciamento de um e-commerce. Construída com Java 21 e Spring Boot, a aplicação fornece endpoints RESTful para o gerenciamento completo de Clientes, Produtos e Pedidos, garantindo integridade de dados e facilidade de integração com interfaces Front-end ou aplicativos Mobile.
O projeto foi desenvolvido com foco em Código Limpo (Clean Code), Arquitetura em Camadas e boas práticas de modelagem de dados relacional (ORM).
A aplicação segue uma arquitetura em camadas bem definida para garantir a separação de responsabilidades e escalabilidade:
controller: Gerencia as requisições HTTP, mapeia os endpoints (URIs) e delega as regras de negócio, retornando os status codes (HTTP 200, 201, etc.) adequados.model: Contém as entidades de domínio (Cliente, Produto, Pedido) mapeadas via JPA/Hibernate para o banco de dados. Utiliza boas práticas como@JsonPropertyOrderpara previsibilidade do JSON e o pacotejava.timepara o tratamento seguro de datas.repository: Interfaces que estendem o Spring Data JPA para comunicação simplificada e eficiente com o banco de dados MySQL, sem a necessidade de queries repetitivas (Boilerplate).
- Java 21: Linguagem de programação (versão LTS mais recente).
- Spring Boot: Framework principal para criação da API REST.
- Spring Data JPA / Hibernate: Para o mapeamento objeto-relacional (ORM) e persistência de dados.
- MySQL: Banco de dados relacional em produção/desenvolvimento.
- Lombok: Automação de getters, setters e construtores, reduzindo a verbosidade do código.
- Maven: Gerenciador de dependências e build do projeto.
- JDK 21 Java 21 instalado (JAVA_HOME Configurado).
- MySQL Workbench Servidor MySQL rodando localmente ou em um container.
git clone https://github.com/Jm619353/baozistore-api.gitcd baozistore-apispring.datasource.url=jdbc:mysql://localhost:3306/baozidb?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true&createDatabaseIfNotExist=true
spring.datasource.username=SEU_USUARIO_MYSQL
spring.datasource.password=SUA_SENHA_MYSQL
spring.jpa.hibernate.ddl-auto=update./mvnw spring-boot:run5. A API estará disponível em http://localhost:8080 .
A API segue os padrões RESTful. Abaixo estão os principais módulos implementados:
| Método | Rota | Descrição |
|---|---|---|
GET |
/clientes |
Lista todos os clientes cadastrados. |
GET |
/clientes/{id} |
Busca um cliente específico pelo ID. |
POST |
/clientes |
Cadastra um novo cliente. |
PUT |
/clientes/{id} |
Atualiza os dados de um cliente existente. |
DELETE |
/clientes/{id} |
Remove um cliente do sistema. |
| Método | Rota | Descrição |
|---|---|---|
GET |
/produtos |
Lista todos os produtos no estoque. |
GET |
/produtos/{id} |
Retorna detalhes de um produto. |
POST |
/produtos |
Cadastra um novo produto (ex: Baozi de Carne Especial). |
PUT |
/produtos/{id} |
Atualiza informações e preços de um produto. |
DELETE |
/produtos/{id} |
Remove um produto do catálogo. |
| Método | Rota | Descrição |
|---|---|---|
GET |
/pedidos |
Lista o histórico completo de pedidos. |
GET |
/pedidos/{id} |
Consulta um pedido específico. |
POST |
/pedidos |
Registra uma nova venda, associando Cliente e Produto. |
PUT |
/pedidos/{id} |
Atualiza o status/quantidade de um pedido. |
DELETE |
/pedidos/{id} |
Cancela e remove um pedido. |
Requisição POST /clientes
{
"nome": "João Miguel",
"clienteDesde": "2024-05-05"
}Resposta(200 OK)
{
"id": 1,
"nome": "João Miguel",
"clienteDesde": "2024-05-05"
}Requisição POST /produtos
{
"nome": "Baozi de Carne Especial",
"preco": 16.00,
"estoque": true
}Resposta(200 OK)
{
"id": 1,
"nome": "Baozi de Carne Especial",
"preco": 16.00,
"estoque": true
}Requisição POST /pedidos
{
"cliente": {
"id": 1
},
"produto": {
"id": 1
},
"quantidade": 7
}Resposta(200 OK)
{
"id": 1,
"cliente": {
"id": 1,
"nome": "João Miguel",
"clienteDesde": "2024-05-05"
},
"produto": {
"id": 1,
"nome": "Baozi de Carne Especial",
"preco": 16.00,
"estoque": true
},
"quantidade": 7
}- Modelagem das entidades centrais (Cliente, Produto).
- Implementar Spring Security com autenticação JWT.
- Containerização da aplicação usando Docker.
- Implementação de testes unitários (JUnit e Mockito) e testes de integração.
- Implementação de camada de Serviço (Service) para isolar ainda mais as regras de negócio complexas.
- Tratamento global de exceções (@ControllerAdvice) para padronizar os erros da API.
- Validação de dados (Spring Boot Validation) no payload de entrada (Ex: @NotBlank, @Min).
- Documentação automatizada no formato OpenAPI (Swagger/OpenAPI 3).
- Configuração de pipeline CI/CD (GitHub Actions).
- Padronizar os HTTP Status Codes da API (ex: retornar 201 Created nos métodos POST e 204 No Content nos métodos DELETE).
Contribuições fazem com que a comunidade open source seja um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.
- Faça um Fork do projeto
- Crie uma Branch para sua Feature (
git checkout -b feature/FeatureIncrivel) - Faça o Commit de suas mudanças (
git commit -m 'Adicionando uma Feature Incrível') - Faça o Push para a Branch (
git push origin feature/FeatureIncrivel) - Abra um Pull Request
⌨️ Desenvolvido com dedicação por Jm619353