Gerenciador de Pedidos - API

📑 - Descrição

A API tem como objetivo principal simplificar o gerenciamento de pedidos, oferecendo uma variedade de recursos essenciais. Com ela, você pode listar pedidos, obtendo detalhes sobre o cliente, os produtos e as quantidades em cada pedido, bem como o preço total. Importante ressaltar que tanto a inserção de novos dados quanto a obtenção de informações são realizadas por meio do formato JSON, garantindo uma integração fácil e flexível.

⚙️ - Bibliotecas

Nesse tópico, gostaria de destacar algumas bibliotecas usei durante o desenvolvimento 😃

  • Spring Boot: Gerenciamento, injeção de dependências e outras configurações;
  • Spring Boot Web: Criação da api restful usando a arquitetura rest;
  • Spring Boot JPA: Mapeamento Objeto-Relacional (ORM);
  • Spring Security Crypto: Criptografia de dados sensíveis;
  • Lombok: Annotations que ajudam a torna o código mais limpo;
  • H2: Banco de dados temporário para testes;
  • PostgreSQL: Banco de dados utilizado em produção;
  • JUnit: Testes unitários.

🖥️ - Pré-requisitos

Certifique-se de ter os seguintes requisitos instalados:

  • Java 17
  • Maven
  • Spring Framework 3
  • PostgreSQL (para a base de dados)
  • IDE de desenvolvimento de sua escolha (por exemplo, IntelliJ IDEA ou Eclipse)

🪛 - Configuração

1. Clonar o Repositório

Clone este repositório para o seu ambiente de desenvolvimento:

git clone https://github.com/seu-usuario/seu-repositorio.git

📁 - Configuração do Banco de Dados

Certifique-se de que o PostgreSQL esteja instalado e configurado corretamente. Edite o arquivo
src/main/resources/application.properties para configurar as informações de conexão com o banco de dados: spring.datasource.url=jdbc:postgresql://localhost:5432/seu-banco-de-dados
spring.datasource.username=seu-usuario
spring.datasource.password=sua-senha

▶️ - Compilar e Executar o Projeto

Navegue até o diretório do projeto:

cd seu-repositorio

Compile o projeto com Maven:

mvn clean install

Execute a aplicação:

mvn spring-boot:run

A API estará disponível em http://localhost:8080.

📋 - Documentação

A documentação completa da API, incluindo todos os endpoints, parâmetros e exemplos de uso, pode ser encontrada aqui.

🤝 - Contribuindo

Se você deseja contribuir com este projeto, siga estas etapas:

  1. Faça um fork do repositório.
  2. Crie uma branch para sua feature: git checkout -b minha-feature
  3. Faça commit das suas alterações: git commit -m 'Adicionar nova feature
  4. Faça push para a branch: git push origin minha-feature
  5. Abra um pull request.

📫 - Contato

Para entrar em contato, envie um email para doardo.ns@gmail.com ou visite meu perfil no Linkedln aqui.