API Final — Estacionamento
Neste tutorial vamos apresentar o Trabalho Final 1 da Unidade Curricular de Sistemas Distribuídos. Este trabalho foi desenvolvido pelo grupo:
-Daniel Pereira
-Bruno Jesus
A nossa API tem como objetivo a gestão de um parque de estacionamento. A aplicação está totalmente documentada em Swagger.
1º Passo
Começámos por criar uma base de dados online, através do MongoDBAtlas, selecionando a opção Build a Cluster.
Escolhemos o tipo de serviço pretendido:
Depois, escolhemos o serviço, a região do nosso servidor, algumas preferências e o nome da nossa Base de Dados:
Obtendo o seguinte:
De seguida iremos obter o link necessário para mais tarde realizarmos a conexão do nosso projeto á BD.
Desenvolvimento da API
Para iniciar, criámos a pasta onde vai ficar todo o nosso projeto, e a partir da linha de comandos instalámos o Nodejs, usando o seguinte comando:
npm init
De seguida instalámos o Express através do comando:
npm install express
E instalámos também o swagger-ui, com o comando:
npm i swagger-ui-express -S
E por último, a extensão do mongoose:
npm install -save express body-parser mongoose
- Para configurar a nossa API, começámos por criar o nosso ficheiro index.js:
- controller.js
- model.js
- model2.js
- routes.js
- swagger.json
Com os ficheiros todos configurados podemos proceder á execução da API através do comando:
node index.js
E acedendo ao URL:
http://localhost:3030/api-docs/
Obtemos o seguinte output:
E podemos verificar todas as funções inseridas.
1 — Inserir novo lugar
2 — Lugares livres em todo o parque
3 — Lugares livres na coluna selecionada
4 — Lista de todos os lugares que estão livres numa determinada coluna
5 — Top 3 dias com mais utilizadores
6–Lista 3 dias com menos utilizadores
7 — Lugares livres no dia selecionado
8 — Média de utilizadores
9 — Dia com mais lucro
10–Média de lucro/receita
Finalmente colocámos a nossa API online através da plataforma Azure, onde anteriormente configuramos a nossa conta:
Começamos por instalar o Add-on da Azure no VisualStudio:
Depois iniciamos a nossa máquina virtual:
Depois acedendo ao link:
https://estacionamentoapi-sd.azurewebsites.net/api-docs/#/
Temos a nossa API a funcionar corretamente e online.