O projeto corrente atende ao trabalho da matéria Webservices And Restful Technologies, que propõe o desenvolvimento de serviços web atendendo requisições RESTFUL para o gerenciamento de uma frota de carros autonomos e também a possibilidade de usuários se inscreverem e solicitar viagens nestes carros.
| Aluno | RM |
|---|---|
| JEAN BRUNO SOUTO VILLETE | RM 335435 |
| MARCOS DE MENEZES SOUTO MOURA | RM 335907 |
O projeto é versionado no github através do repositório github.com/fiap-rebu
As atividades levantadas para serem desenvolvidas de acordo com cada caso de uso estão geridas no projeto github/fiap-spring
Uma das opções é o download do jar já empacotado, o que dispensaria a necessidade de utilização de ferramentas para build do código fonte.
Necessário fazer download da versão corrente disponível em; fiap.rebu-0.0.1-RELEASE.jar
Após o download, invocar comando abaixo via terminal;
$ java -jar fiap.rebu-0.0.1-RELEASE.jar
Após efetuar o clone do código, utilize o comando abaixo para excução da aplicação.
NOTA: Requisitos, maven e Java 8.
$ mvn spring-boot:run
Utilize o script disponível no diretório bash-test-case para criação de massa de exemplo, invocando via terminal;
$ ./bash-test-case/test-case-1.sh
Elaborar uma aplicação Web consumindo os Web Services de um sistema de controle de uma frota de veículos autônomos.
Elaborar os serviços necessários para o controle de uma frota de veículos autônomos, ideia principal:
- Usuário solicita um veículo;
- Sistema seleciona um veículo que esteja
- disponível e desloca até o local do usuário;
- Usuário entra no veículo;
- Sistema conduz o usuário até o local informado;
Pontos críticos para avaliação:
- Construção de API dentro dos padrões REST (visto em sala de aula);
- Documentação (OpenAPI, Postman etc);
- Aplicação Web consumindo os serviços.
- Código-fonte em um VSC (exemplo: GitHub).
Pontos extras:
- Persistência;
- Consumo de outras API's (exemplo: Geolocalização do Google Maps);
- Deploy na Nuvem;
Será necessário entregar aqui no Portal do Aluno:
- Nome da aplicação;
- Endereço do Código-fonte;
- Se hospedado, informar o endereço da aplicação;
- Documentação da API;
- Print’s ou vídeo comprovando a implementação (telas no navegador e chamadas no Postman).
- o usuário que faz utilização do serviço de viagens com veículos autônomos
- será mantido apenas um
nickname(apelido/login) do usuário
- será mantido apenas um
- composto basicamente da informação de endereço (address), utilizado pela entidade veículo e viagem/corrida (TRIP).
- um veículo que faz parte da frota de automóveis autônomos.
- para o registro de um veículo, as informações deste são;
- placa (identificador, não pode haver duplicidades)
- localização (no registro inicial, deve-se indicar sua localização inicial, e depois de atender viagens, sua localização será dinâmica)
- entidade composta de dados de quando um veículo entrou e saiu do estado de manutenção
- entidade que compõe e liga um usuário a um veículo e a viagem/corrida em si, com os dados de origem e destino
abaixo segue a lista de casos de uso e exemplos de requisições e respostas;
5.1 - [use case: listar veículos da frota] issue #4
- o caso de uso para listagem de veículos tem por objetivo devolver uma lista de payloads que represente os dados dos
veículos e que seja renderizado esta lista em um frontend, com as informações;
- placa (identificador)
- localização
- status
- Em Manutenção
- Em Trânsito Buscar Passageiro
- Em Trânsito Aguardando Embarque Passageiro
- Em Trânsito Com Passageiro
- Disponível
[request]
GET /vehicles
[response]
200 Ok
[
{
"plate": "ABC-1234",
"location": "Rua X, Nr 1098, bairro Y, cidade baixa",
"status": "REPAIRING"
},
{
"plate": "CBA-6633",
"location": "Rua José, Nr 18, centro",
"status": "ON_THE_WAY_TO_GET_PASSENGER"
},
{
"plate": "ABC-0099",
"location": "Rua Madureira, Nr 111, são paulo",
"status": "HOLDING_ON_FOR_ON_BOARDING"
},
{
"plate": "DDD-6633",
"location": "Rua José, Nr 18, centro",
"status": "TRIP_ON_THE_WAY"
},
{
"plate": "ABC-4321",
"location": "Rua José, Nr 18, centro",
"status": "AVAILABLE"
}
]
5.2 - [use case: cadastrar novo veículo] issue #5
- para cadastrar um veículo, deve-se fornecer um payload com os dados;
- placa
- localização
[request]
POST /vehicles
{
"plate": "ZZZ-9999",
"location": "Rua X, Nr 1098, bairro Y, cidade baixa"
}
[response]
201 Created
5.3 - [use case: colocar um veículo em manutenção] issue #6
- para atualização dos dados de um veículo, deve-se fornecer via query string a placa atual e um payload com os dados;
- possível nova placa
- localização
- caso a placa corrente fornecida via query string seja inválida ou não existir um registro para a mesma, devolver 404 Not Found
[request]
PATCH /vehicles/ABC-1234/repair/do
[response]
200 Ok
5.4 - [use case: remover estado de manutenção do veículo] issue #7
- para atualização dos dados de um veículo, deve-se fornecer via query string a placa atual e um payload com os dados;
- possível nova placa
- localização
- caso a placa corrente fornecida via query string seja inválida ou não existir um registro para a mesma, devolver 404 Not Found
[request]
PATCH /vehicles/ABC-1234/repair/done
[response]
200 Ok
5.5 - [use case: cadastrar usuário] issue #8
- para cadastrar um usuário, deve-se fornecer um payload com os dados;
- nickname
[request]
POST /users/
{
"nickname": "sampleusr"
}
[response]
201 Created
5.6 - [use case: usuário solicita veículo para viagem] issue #9
- caso já exista uma viagem em aberta para o usuário, então este não pode solicitar uma nova viagem, logo devolver mensagem informando do problema com status 412 Precondition Failed
- para uma nova viagem, o usuário deve fornecer o local de encontro e o destino
- o nickname para login deve ser fornecido via "path variable"
- se o usuário não for encontrado, devolver mensagem informando o ocorrido com status 400 Bad Request
- os campos localização de origem e destino são obrigatórios, e caso não for fornecido, devolver mensagem informando o ocorrido com status 400 Bad Request
- a localização de origem e destino do usuário devem ser registradas na tabela de domínio LOCATION
- o retorno da criação da viagem é um identificador (uuid)
- a viagem em si é uma tupla para o domínio TRIP que é composto/agragador dos dados para;
- um usuário
- um veículo (até este momento disponível)
- um local de origem
- um local de destino
- a viagem em si é uma tupla para o domínio TRIP que é composto/agragador dos dados para;
- a aplicação deve achar um veículo que esteja disponível para fazer a viagem, e colocar este veículo no estado de em transito para o local de origem do usuário, ou seja, local de origem da viagem
- um veículo disponível para viagem é uma tupla de VEHICLE onde;
- não há relação com REPAIR#closeDateTime == null; se o veículo estiver com um reparo em aberto, este veículo está em manutenção e logo não está disponível
- não há relação com TRIP#landingDateTime == null; se o veículo está em uma viagem que ainda não ocorreu o desembarque, o veículo não está disponível
- caso não for encontrado nenhum veículo disponível, deve ser retornado uma mensagem informando que nenhum veículo disponível foi encontrado para a viagem e devolver o código 412 Precondition Failed
- um veículo disponível para viagem é uma tupla de VEHICLE onde;
[request]
POST /users/sampleusr/trips/
{
"fromLocation": "Rua José, Nr 18, centro",
"toLocation": "Rua X, Nr 1098, bairro Y, cidade baixa"
}
[response]
201 Created
{
"uuid": "7364259a-94aa-4c37-ad39-5e9837c0fd3e",
"fromLocation": "Rua José, Nr 18, centro",
"toLocation": "Rua X, Nr 1098, bairro Y, cidade baixa"
}
5.7 - [use case: confirmar embarque da viagem] issue #10
este caso de uso necessita que já exista determinado usuário com uma viagem em aberto, sem embarque associada a este usuário
- o nickname para login deve ser fornecido via "path variable"
- se o usuário não for encontrado, devolver mensagem informando o ocorrido com status 400 Bad Request
- o uuid da viagem deve ser fornecido via "path variable"
- se o usuário não tiver a viagem identificada pelo uuid associada, devolver mensagem de erro do ocorrido com status 400 Bad Request
- a viagem precisa ter a informação data do embarque não populada, caso contrário, devolver mensagem informando o ocorrido com status 412 Precondition Failed
- a localização do veículo deve ser alterada para a localização do embarque (origem) da viagem
[request]
PATCH /users/sampleusr/trips/boarding/7364259a-94aa-4c37-ad39-5e9837c0fd3e
[response]
200 OK
5.8 - [use case: confirmar conclusão da viagem] issue #11
este caso de uso necessita que já exista determinado usuário com uma viagem em aberto, com data de embarque populada, mas viagem não finalizada (landing date time is null) associada a este usuário
- o nickname para login deve ser fornecido via "path variable"
- se o usuário não for encontrado, devolver mensagem informando o ocorrido com status 400 Bad Request
- o uuid da viagem deve ser fornecido via "path variable"
- se o usuário não tiver a viagem identificada pelo uuid associada, devolver mensagem de erro do ocorrido com status 400 Bad Request
- a viagem precisa ter as informações data de embarque devidamente populada e a data de desembarque/finalização não populada, caso contrário, devolver mensagem informando o ocorrido com status 412 Precondition Failed
- a localização do veículo deve ser alterada para a localização do desembarque (destino) da viagem
[request]
PATCH /users/sampleusr/trips/landing/7364259a-94aa-4c37-ad39-5e9837c0fd3e
[response]
200 OK