Aplicação Algalog

• Descrição:

  O projeto consiste em um sistema básico de logística, criado para gerenciamento de entregas (delivery), através do cadastro de dados de uma entrega, registro dos relacionamentos com o respectivo Cliente e Destinatário, e o controle do fluxo da entrega, por meio do status, com possibilidades de registrar o histórico de possíveis ocorrências relacionadas as entregas.

• Tabela de Conteúdos:

  • Modelo de Domínio
  • Arquitetura
  • Endpoints
  • Instruções para Executar
  • Tecnologias Utilizadas

• Modelo de Domínio

  Este é o modelo de domínio definido para o projeto, foi construído utilizando a ferramenta de modelagem Astah, na versão gratuíta Community, nele é possível visualizar as tabelas, atributos, relacionamentos, cardinalidades e chaves primárias.

  

• Arquitetura

  A arquitetura da aplicação segue o padrão MVC, incluindo camadas de Modelo, Repositório, Serviço e Controlador, além de manipuladores de exceções personalizados para fornecer respostas de erro mais úteis e informativas.

  

• Endpoints:

  A seguir, estão listados os principais endpoints da API com suas respectivas funcionalidades:

  Visualizar aqui.

  • Endpoint: {/clientes}

  Rest	Request	Funcionalidade
  PUT	Clientes - Atualizar	Atualiza os dados cadastrados de um Cliente
  POST	Clientes - Cadastrar	Realiza o cadastro de dados de um Cliente
  DEL	Clientes - Excluir	Exclui o cadastro de um Cliente através do ID
  GET	Clientes - Listar	Retorna todos os Clientes e seus respectivos dados cadastrados na plataforma
  POST	Clientes - Buscar	Permite que o usuário pesquise por um Cliente específico através do ID

  • Endpoint: {/entregas}

  Rest	Request	Funcionalidade
  GET	Entregas - Listar	Retorna todas as entregas cadastradas, dados de destinatários e taxa de delivery
  GET	Entregas - Obter ID	Retorna os dados de uma Entrega específica através do ID
  PUT	Entregas - Finalizar	Permite ao usuário finalizar uma Entrega, caso o seu status seja Finalizada
  POST	Entregas - Solicitar	Permite que o usuário solicite uma Entrega, adicionando os dados de Destinatário

  • Endpoint: {/entregas/{id}/ocorrencias}

  Rest	Request	Funcionalidade
  GET	Ocorrências - Listar	Retorna os dados das Entregas que tiveram (ou não) alguma Ocorrência durante o delivery
  POST	Ocorrências - Solicitar	Permite ao usuário realizar uma eventual ocorrência que houve durante a Entrega

  Todos os endpoints estão disponíveis para testes, feedbacks e afins. Clique no botão abaixo para abrir no Postman.

  

• Instruções para Executar

• Pré-Requisito:

  • Java (JDK 17)
    

  # Clonar repositório - SSH
  git clone [email protected]:marcosrebelo97/rest-api-algalog.git
  
  # Acessar pasta do projeto back-end
  cd rest-api-algalog
  
  # Instalar as dependências do Maven
  mvn install
  
  # Executar o projeto
  ./mvnw spring-boot:run

Tecnologias Utilizadas

• Java (JDK 17)
• Spring Boot
• Spring Data JPA / Hibernate
• Spring Boot Web
• Flyway
• Lombok
• Maven
• H2 Datbase
• PostgreSQL | DBeaver
• Postman

Colaborador

Marcos Guerreiro Rebelo