REST API Parking
- #Spring Boot / Spring Framework
- #Java
Cloud Parking
REST API para controle de estacionamento de carros
Project features
- Obtém todos os veículos estacionados
- Obtém somente um veículo estacionado através do ID
- Criação de novos veículos estacionados
- Atualização de dados do veículo estacionado
- Calcula o valor a ser pago pelo tempo de uso do estacionamento
- Deleta os dados do veículo passando o ID
Getting Started
Para executar o projeto, será necessário instalar os seguintes programas:
- JDK 11
- Maven 4.0.0
- Editor de sua preferência
Development
Para iniciar o desenvolvimento, é necessário clonar o projeto do GitHub num diretório de sua preferência:
cd "diretorio de sua preferencia"
git clone https://github.com/dgleyramos1/cloud-parking.git
Build
Para construir o projeto com o Maven, executar os comando abaixo:
mvn clean install
O comando irá baixar todas as dependências do projeto e criar um diretório *target* com os artefatos construídos, que incluem o arquivo jar do projeto. Além disso, serão executados os testes unitários, e se algum falhar, o Maven exibirá essa informação no console.
Tests
Para rodar os testes, utilize o comando abaixo:
mvn test
Routes
Documentação com Swagger
/swagger-ui.html
GET -> Find All Parkings
/parking
GET -> Find Parking By Id
/parking/{id}
POST -> Create New Parking
/parking
PUT -> Update Parking
/parking/{id}
POST -> Parking exit validation
/parking/{id}/exit
DELETE -> Delete Parking
/parking/{id}
Models
Parking
- id: String
- color: String
- license: String
- model: String
- state: String
- entryDate: date-time
- exitDate: date-time
- bill: Double
ParkingCreateDTO
- color: String
- license: String
- model: String
- state: String
ParkingDTO
- color: String
- license: String
- model: String
- state: String
- entryDate: date-time
- exitDate: date-time
- bill: Double
Contributions
Contribuições são sempre bem-vindas! Para contribuir lembre-se sempre de adicionar testes unitários para as novas classes com a devida documentação.
Links
Documentação: DOC
Github: Repo
Author
Dgley Ramos