This is a web application using Django, and based on api data https://vpic.nhtsa.dot.gov/api/. App allows user to check existence of provided car brand and model, and adding it to the database if exists. Another function is possibility to rate cars.
The provided Docker Compose file allows you to run the app locally in development. To start the container, run:
$ docker-compose up
Once the stack has launched, you can test the application by executing GET/POST commands described below.
$ python ./manage.py test
The REST API to the example app is described below.
/cars/
curl -i -H 'Accept: application/json' http://localhost:8000/cars/
Example responses
[
{
"id": 1,
"car_make": "HONDA",
"model_name": "CIVIC",
"rate_point__avg": 3.6666666666666665
},
{
"id": 2,
"car_make": "AUDI",
"model_name": "TT",
"rate_point__avg": null
},
{
"id": 3,
"car_make": "FIAT",
"model_name": "DUCATO",
"rate_point__avg": 3.5
}
]| Status | Meaning | Description |
|---|---|---|
| 200 | OK | List of added cars |
POST /cars/
curl -i -H 'Accept: application/json' -d 'car_make=sample-name&model_name=sample-model' http://localhost:8000/cars/
Body parameter
{
"car_make": "Audi",
"model_name": "TT"
}Example responses
{
"Message": "Car successfully added!"
}| Status | Meaning | Description |
|---|---|---|
| 200 | OK | Car added do the database |
| 422 | Unprocessable Entity | Wrong Payload Type |
POST /rate/
curl -i -H 'Accept: application/json' -d 'car_make=sample-name&model_name=sample-model' http://localhost:8000/rate/
Body parameter
{
"car_id": "101",
"rate_point": "4"
}Example responses
{
"Message": "Car AUDI TT successfully rate to 4!"
}| Status | Meaning | Description |
|---|---|---|
| 200 | OK | Rate added |
| 404 | Not Found | Car not found |
POST /popular/
curl -i -H 'Accept: application/json' http://localhost:8000/popular/
Example responses
[
{
"id": 1,
"car_make": "HONDA",
"model_name": "CIVIC",
"total_rate_entries": 3
},
{
"id": 3,
"car_make": "FIAT",
"model_name": "DUCATO",
"total_rate_entries": 2
},
{
"id": 2,
"car_make": "HONDA",
"model_name": "CIVIC",
"total_rate_entries": 0
},
{
"id": 4,
"car_make": "AUDI",
"model_name": "TT",
"total_rate_entries": 0
}
]| Status | Meaning | Description |
|---|---|---|
| 200 | OK | List of cars sorted by popularity |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent