Api-drone-feeder

Sobre o Projeto

Aplicação desenvolvida para disponibilizar uma API com funcionalidades de criar, ler, modificar e deletar informações relativas a entregas de pacotes e encomendas realizadas por drones, incluindo upload e download de vídeos.

Tecnologias e Ferramentas empregadas

Java 11; Spring Boot; JUnit 5; Maven; MySQL; e Docker.

Status do Projeto

Aplicação em funcionamento, incluindo os testes unitários.

Acesso à Aplicação

Antes da instalação

Fazer o Clone do repositório.

Instalação e Execução

A. Entrar no diretório raiz da aplicação:

$ cd Api-drone-feeder

B. Instalar a aplicação pelo Docker Compose, através do comando:

$ docker-compose up -d

C. Serão iniciados os dois containers:

container docker db, com o banco de dados em MySQL; e
container docker spring-boot-app, com a aplicação em Java 11 (Spring Boot).

D. Acessar as rotas abaixo (em http://localhost:8080):

POST /drone/new

A requisição contendo no body: "name", String possuindo somente letras maiúsculas e números, com 4 caracteres; "model", String com até 32 caracteres; e "capacityWeightInKg", Float.

{ 
  "name": "P306",
  "model": "DJI Phantom Pro 4",
  "capacityWeightInKg": 2.72
}

Retorna status 201 e body com a instância do drone cadastrado.

{ 
  "id": 4,
  "name": "P306",
  "model": "DJI Phantom Pro 4",
  "capacityWeightInKg": 2.72
}

GET /drone/all

Retorna status 200 e body com as instâncias dos drones cadastrados.

[
  ...,
  { 
    "id": 4,
    "name": "P306",
    "model": "DJI Phantom Pro 4",
    "capacityWeightInKg": 2.72
  }
]

GET /drone/{id}

A requisição contendo um id existente na rota retorna status 200 e body a instância do drone cadastrado.

{
  "id": 4,
  "name": "P306",
  "model": "DJI Phantom Pro 4",
  "capacityWeightInKg": 2.72
}

DELETE /drone/delete/{id}

A requisição contendo um id existente na rota retorna status 200 e body a mensagem que o drone foi deletado.

{ 
  "message": "Id 4 has been removed."
}

PUT /drone/update/{id}

A requisição contendo um id existente na rota e no body: "name", String possuindo somente letras maiúsculas e números, com 4 caracteres; "model", String com até 32 caracteres; e "capacityWeightInKg", Float.

{ 
  "name": "M307",
  "model": "DJI Matrice 600 Pro",
  "capacityWeightInKg": 6.8
}

Retorna status 200 e body com a instância do drone atualizado.

{
  "id": 4,
  "name": "M307",
  "model": "DJI Matrice 600 Pro",
  "capacityWeightInKg": 6.8
}

POST /delivery/new

A requisição contendo no body: "receiverName", String com até 32 caracteres; "address", String com até 32 caracteres; "zipCode", String no formato padrão de CEP (12345-678); "latitude", no formato padrão de latitude; "longitude", String no formato padrão de longitude; e "weightInKg", Float.

{
  "receiverName": "Francisco Pereira Passos",
  "address": "Av. Rio Branco, 63, Centro, Rio de Janeiro, RJ.",
  "zipCode": "20090-004",
  "latitude": "-22.901163",
  "longitude": "-43.178857",
  "weightInKg": 3.5
}

Retorna status 201 e body com a instância da entrega cadastrada.

{
  "id": 3,
  "receiverName": "Francisco Pereira Passos",
  "address": "Av. Rio Branco, 63, Centro, Rio de Janeiro, RJ.",
  "zipCode": "20090-004",
  "latitude": "-22.901163",
  "longitude": "-43.178857",
  "status": "TO_DELIVER",
  "weightInKg": 3.5,
  "videoName": "None"
}

POST /delivery/{id}/uploadVideo

A requisição contendo no body um arquivo "video", dentro dos padrões estabelecidos, retorna status 201 e body com a instância da entrega atualizada.

{
  "id": 2,
  "receiverName": "Praça Pio X, s/n - Centro, Rio de Janeiro - RJ",
  "address": "Wolfgang Amadeus Mozart",
  "zipCode": "20040-020",
  "latitude": "-22.900698",
  "longitude": "-43.177297",
  "status": "DELIVERED",
  "weightInKg": 2.5,
  "videoName": "A011-2013-03-14-101033.mp4"
}

GET /delivery/allVideos

Retorna status 200 e body com as instâncias dos vídeos cadastrados.

[
  ...,
  {
    "id": 2,
    "fileName": "A011-2013-03-14-101033.mp4",
    "size": 2861955,
    "droneName": "A011"
  }
]

GET /delivery/video/{id}

A requisição contendo um id de um vídeo existente na rota retorna status 200 e body com a instância do vídeo cadastrado.

{
  "id": 2,
  "fileName": "A011-2013-03-14-101033.mp4",
  "size": 2861955,
  "drone": {
    "id": 1,
    "name": "A011",
    "model": "DJI Matrice 100",
    "capacityWeightInKg": 3.6
  }
}

GET /delivery/all

Retorna status 200 e body com as instâncias das entregas cadastradas.

[
  ...,
  { 
    "id": 2,
    "receiverName": "Praça Pio X, s/n - Centro, Rio de Janeiro - RJ",
    "address": "Wolfgang Amadeus Mozart",
    "zipCode": "20040-020",
    "latitude": "-22.900698",
    "longitude": "-43.177297",
    "status": "DELIVERED",
    "weightInKg": 2.5,
    "videoName": "A011-2013-03-14-101033.mp4"
  }
]

GET /delivery/{id}

A requisição contendo um id vídeo existente na rota retorna status 200 e body com a instância da entrega cadastrada.

{
  "id": 2,
  "receiverName": "Praça Pio X, s/n - Centro, Rio de Janeiro - RJ",
  "address": "Wolfgang Amadeus Mozart",
  "zipCode": "20040-020",
  "latitude": "-22.900698",
  "longitude": "-43.177297",
  "status": "DELIVERED",
  "weightInKg": 2.5,
  "video": {
    "id": 2,
    "fileName": "A011-2013-03-14-101033.mp4",
    "size": 2861955,
    "droneName": "A011"
  }
}

DELETE /delivery/delete/{id}

A requisição contendo um id existente na rota retorna status 200 e body com a mensagem que a entrega foi deletada.

{
  "message": "Delivery id 2 has been removed."
}

PUT /delivery/update/{id}

A requisição contendo um id existente na rota e no body: "receiverName", String com até 32 caracteres; "address", String com até 32 caracteres; "zipCode", String no formato padrão de CEP (12345-678); "latitude", no formato padrão de latitude; "longitude", String no formato padrão de longitude; e "weightInKg", Float.

{
  "receiverName": "Francisco Pereira Passos",
  "address": "Av. Rio Branco, 63, Centro, Rio de Janeiro, RJ.",
  "zipCode": "20090-004",
  "latitude": "-22.901163",
  "longitude": "-43.178857",
  "weightInKg": 3.5
}

Retorna status 200 e body com a instância da entrega atualizado.

{
  "id": 2,
  "receiverName": "Francisco Pereira Passos",
  "address": "Av. Rio Branco, 63, Centro, Rio de Janeiro, RJ.",
  "zipCode": "20090-004",
  "latitude": "-22.901163",
  "longitude": "-43.178857",
  "status": "TO_DELIVER",
  "weightInKg": 3.5,
  "videoName": "None"
}

GET /delivery/{id}/downloadVideo

A requisição contendo um id da entrega existente na rota, a qual possui um vídeo, retorna status 200 e body com o arquivo do vídeo da referida entrega.

Save response to file: A011-2013-03-14-101033.mp4.

DELETE /delivery/{id}/deleteVideo

A requisição contendo um id da entrega existente na rota, a qual possui um vídeo, retorna status 200 e body com a instância da entrega atualizado.

{
  "id": 2,
  "receiverName": "Francisco Pereira Passos",
  "address": "Av. Rio Branco, 63, Centro, Rio de Janeiro, RJ.",
  "zipCode": "20090-004",
  "latitude": "-22.901163",
  "longitude": "-43.178857",
  "status": "TO_DELIVER",
  "weightInKg": 3.5,
  "videoName": "None"
}

Contribuintes

Nome	GitHub
Moisés Fernandes	https://github.com/moisesfdasilva

Contato

GitHub: Repositório-Api-drone-feeder

moisesfdasilva/Api-drone-feeder