Esta API é o Projeto Final da disciplina API RESTful do programa de Residência Full Stack do Serratec 2024.2. O objetivo é simular a API de um ecommerce.
- Java 17
- Spring Boot
- PostgreSQL
- Postman
- Swagger
- API Via Cep
- Cadastro de clientes, produtos, pedidos e itens.
- Busca de CEP utilizando a API Via Cep.
- Geração de relatório de itens pedidos.
- Consultas de clientes, produtos e itens pedidos.
/clientes- Cadastro e gerenciamento de clientes./produtos- Cadastro e gerenciamento de produtos./pedidos- Gerenciamento de pedidos e seus itens./itenspedidos- Detalhes e consultas dos itens pedidos.
- Java 17 instalado
- Eclipse IDE
- PostgreSQL instalado e configurado
- Postman
-
Clone este repositório:
git clone https://github.com/seu-usuario/ecommerce-serratec-pub.git ecommerce-serratec-pub
-
Navegue até o diretório do projeto:
cd ecommerce-serratec-pub -
Instale as dependências:
mvn install
-
Configure o banco de dados no arquivo
application.propertiescom suas credenciais do PostgreSQL:spring.datasource.url=jdbc:postgresql://localhost:5432/nome_do_banco spring.datasource.username=seu_usuario spring.datasource.password=sua_senha
-
Execute a aplicação:
mvn spring-boot:run
-
Acesse a documentação Swagger para testar os endpoints:
http://localhost:8080/swagger-ui.html*importante verificar se a aplicação estará apta a rodar na porta 8080. Caso não aconteça, tente mudar para 8081, por exemplo.
- src/main/java: Contém a lógica da aplicação e a estrutura de pacotes.
- src/main/resources: Contém arquivos de configuração, como
application.properties.
A API gera um relatório detalhado dos itens pedidos, que pode ser acessado por meio do endpoint /itenspedidos.
O projeto está integrado à API Via Cep para facilitar a busca de endereços a partir de um CEP informado. Para utilizar essa funcionalidade, basta acessar o endpoint /cep com o CEP desejado.