Giter Club home page Giter Club logo

shortestpath's Introduction

Como executar a aplicação

API

  • Entrar na pasta da aplicação API (ShortestPathRest);
  • Executar o build da API:
./gradlew build
  • Executar a aplicação:
java -jar ./build/libs/ShortestPathRest-1.0.jar ../input-file.txt

Console

  • Entrar na pasta da aplicação Console (ShortestPath);
  • Executar o build da aplicação:
./gradlew build
  • Executar a aplicação:
java -jar ./build/libs/ShortestPath.jar

Estrutura de Arquivos e Pacotes

  • ShortestPath: Console de aplicação que será utilizada pelo usuário para obter o menor caminho;
    • src: Código Fonte da Aplicação
      • main: Aplicação
        • java/br/com/bexs/shortestpath
          • Application.java: Entrada da Aplicação, responsável pela iteração com o usuário: Entrada e Saída de informações;
          • HttpUtil.java: Responsável pela comunicação com a API, encapsula método de consulta de HTTP;
          • Route.java: POJO responsável pela estrutura de dados retorno do menor caminho;
          • Service.java: Realiza a consulta da API via HTTP (HttpUtil) e mapeia o resultado de Json para Objeto (Route).
      • test: Testes Unitários
  • ShortestPathRest: Aplicação SpringBoot com a API Rest para encontrar o menor caminho e gerenciar as rotas;
    • src: Código Fonte da Aplicação API
      • main/java/br/com/bexs/shortestPathRest
        • ShortestPathRestApplication.java: Entrada da aplicação SpringBoot;
          • controller
            • Route.java: POJO responsável pela estrutura de dados retorno do menor caminho;
            • RoutesController.java: Responsável por expor os métodos de iteração com as rotas (inclusão, exclusão e obtenção);
            • ShortetestPathController.java: Responsável por expor o método de consulta de menor caminho;
          • database
            • City.java: POJO responsável pela estrutura de Cidades, utilizado para executar o algoritmo de Dijkstra;
            • DataBase.java: Mantém a estrutura de Cidades que será utilizada pelo algortimo de Dijkstra;
            • Graph.java: Responsável pela implementação do algortimo de menor caminho, baseado no ;
            • Route.java: POJO responsável pela estrutura de Rotas unindo os pontos de origem e destino, utilizado para executar o algoritmo de Dijkstra;
            • TextManagement.java: Realiza a iteração com o arquivo texto para leitura e gravação das informações;

Decisão de Arquitetura

Console

  • Criação de uma estrutura de chamada de HTTP (HttpUtil) encapsulando as chamadas HTTP, podendo ser extendido para futuras chamadas POST, DELETE, PUT, etc.;
  • Como o console apenas realiza a integração com o menor caminho, foi criado um único serviço (Service), em caso de multiplas chamadas o intúito é criar serviços específico para cada uso, podendo segmentar futuramente em "packages" isolados;
  • A aplicação está sendo executada na classe Application por ser extremamente enxuta, se houver necessidade de segmentação de funções, por exemplo, incorporar funcionalidade de manuntenção de rotas, então seria ideal criar um estrutura segmentada através de "packages", por exemplo: console.shortestPath, console.routes, etc. .

API

  • Criada estrutura para Controller, que receberá todos os Endpoints expostos para consumo via REST;
  • Inicialmente a lógica está ocorrendo na integração entre Controller e Graph, mas o ideal seria criar Services para cada utilização e DAO's na utilização de integração com Banco de Dados.

Detalhamento da API

  • /route
    • Método GET: Retorna todas as rotas disponíveis;
    • Método PUT: Inclui uma nova rota com a inclusão de um Json no formato abaixo:
    {
      "origin": "SCL",
      "destination": "CDG",
      "distance": 50
    }
    • Método DELETE: Excluir uma rota previamente cadastrada
  • /shortestPath
    • Método GET: Calcula e retorna o menor caminho entre dois pontos, se houver.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.