Truck Driver Api

Guia

Dependencias
Estrutura do projeto
Configuracao
Execucao

Dependencias

Este projeto utiliza diversas ferramentas e plugins, sendo eles:

Ferramentas

Obrigatorios:
- NodeJS 8+
- MongoDB (Caso não utilize a imagem docker)
Opcionais:
- Docker

Plugins

Obrigatorios:
- Eslint
Opcionais:
- Editorconfig
- Yaml Support

Estrutura do projeto

Este projeto contem pastas e arquivos que servem para certos propositos segue a lista dos mesmos:

Pastas

_/ 'Raiz'
__/__tests__ 'Contem arquivos dos testes unitarios'
__/coverage 'Contem arquivos dos relatorios gerados atraves dos testes'
__/config 'Contem arquivos de configuracao do projeto para deploy e execucao'
__/fixtures 'Contem arquivos para executar a migracao das entidades'
__/mongoose 'Contem pasta de modelos e arquivo de conexao com MongoDB'
___/models 'Contem arquivos de definicao de schema das entidades'
__/services 'Contem os serviços das entidades'
___/entidade 'Contem arquivos que sao as funcoes desta entidade'
__/utils 'Contem arquivos e funcoes utilitarias'

Configuração

Existem 2 formas de executar o projeto de forma local, uma utilizando o Docker, onde é necessário instalar o Docker antecipadamente para poder rodar o docker-compose, e após a instalação executar os comandos:

docker-compose build
docker-compose up -d

Outra forma é utilizando diretamente o serverless offline, mas para isso é necessário alterar a url de configuração do mongo (que está no local default apontando para a url do docker), apontando para o uri desejado no arquivo .env.app.yml que se encontra na pasta config, após a configuração do mongo rodar os comandos:

npm install serverless -g
npm install
npm run start:fixture

É usado o start:fixture para cadastrar previamente os tipos de caminhão e 1000 motoristas na base com o faker.

Testes unitários

Para rodar os testes unitários:

npm test

Caso queira ver cobertura dos testes:

npm test:coverage

Endpoints:

Para qualquer uma das alternativas (Docker ou não) a API fica disponível na url: http://localhost:3000/

URL

/drivers
Method:

POST
Exemplo de Body

{
  "name": "Ladislau Albuquerque",
  "birthDate": "1999-06-17T02:06:16.939Z",
  "gender": "Masculino",
  "truckOwner": false,
  "licenseType": "C",
  "loaded": true,
  "truckType": {
    "cod": "1",
    "name": "Caminhão 3/4"
  },
  "origin": {
    "lat": "-5.9913",
    "lng": "83.1169"
  },
  "destination": {
    "lat": "-78.1746",
    "lng": "-122.4182"
  }
}

URL

/drivers

<Atualiza um motorista.>
Method:

PUT
Exemplo de Body

{
  "name": "Ladislau Albuquerque",
  "birthDate": "1999-06-17T02:06:16.939Z",
  "gender": "Masculino",
  "truckOwner": false,
  "licenseType": "C",
  "loaded": true,
  "truckType": {
    "cod": "1",
    "name": "Caminhão 3/4"
  },
  "origin": {
    "lat": "-5.9913",
    "lng": "83.1169"
  },
  "destination": {
    "lat": "-78.1746",
    "lng": "-122.4182"
  }
}

URL

/drivers

<Busca um motorista em diferentes condições dependendo do parametro querystring passado, é possível combinar todos os parametros de querystring._>
Method:

GET
URL Params

Opcionais:

page=[integer] - Pagina do resultado

limit=[integer] - Limite de itens por pagina do resultado

sort=[string] - Campo que quer realizar o sort (Ex: -name)

loaded=[boolean] - Se o caminhão está carregado no terminal ou não. (Opções: true|false)

truckOwner=[boolean] - Se o motorista é o dono do caminhão. (Opções: true|false)

countOnly=[boolean] - Se é para trazer somente o count dos resultados ao invés da lista completa. (Opções: true|false)

period=[string] - Para trazer o relatório do dia, da semana ou do mês corrente. (Opções: day|week|month)
URL

/itineraries/{truckType}

<Busca os itinerários pelo tipo de caminhão passado na URL._>
Method:

GET
Path Params

Obrigatório:

truckType=[integer] - Pathparam com o código do caminhão que se quer puxar os itinerários. (Opções: 1|2|3|4|5 *Ele valida no banco antes se o tipo existe)

majoraze/truck-api