https://github.com/ajsalemo/pythonflaskapi
A Flask REST API that exposes some BMW M Performance model data.
https://github.com/ajsalemo/pythonflaskapi
api-rest azure bmw flask flask-sqlalchemy gunicorn jinja2 json postgres python shell
Last synced: 3 months ago
JSON representation
A Flask REST API that exposes some BMW M Performance model data.
- Host: GitHub
- URL: https://github.com/ajsalemo/pythonflaskapi
- Owner: Ajsalemo
- Created: 2020-09-24T23:18:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-28T23:14:10.000Z (over 4 years ago)
- Last Synced: 2026-01-03T15:30:21.632Z (6 months ago)
- Topics: api-rest, azure, bmw, flask, flask-sqlalchemy, gunicorn, jinja2, json, postgres, python, shell
- Language: Python
- Homepage: https://pythonflaskapi.azurewebsites.net/
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PythonFlaskAPI
### A small REST API that exposes data about BMW M performance models
https://pythonflaskapi.azurewebsites.net/
## Routes
### /api/v1/cars/all -
#### Retrieve all cars
#### JSON Format - Array of Objects:
{
"all_cars": [
{
"Body": "Coupe",
"Displacement": "3.5-litre",
"Engine_Type": "l6",
"Model": "M1",
"Power": "273 hp",
"Production": "1978-1981",
"Production_Number": "453",
"Type": "E26",
"id": 1
},
{
....
},
{
....
}
]
}
### /api/v1/cars/all_models -
#### Retrieve all models prefixed with the year, such as "2006-2010 M3"
#### JSON Format - Array:
{
"all_models": [
"1978-1981 M1",
"1980-1984 M535i",
"1984-1989 M635CSi",
....
...
..
]
}
### /api/v1/cars/model_types -
#### All generation types - ex. "E46" or "E60"
#### JSON Format - Array:
{
"all_models": [
"E26",
"E12",
"E24",
....
...
..
]
}
### /api/v1/cars/models/ -
#### Specify a model information to retrieve, where is the string based parameter - ex. /api/v1/cars/models/m3
#### JSON Format - Array of Objects - if multiple matching values are returned, they will be in the form of an Array of Objects:
{
"model": [
{
"Body": "Coupe, Convertible",
"Engine_Type": "l4",
"Model": "M3",
"Power": "191 hp to 234 hp",
"Production_Number": "17,184 (Coupe); 786 (Convertible)",
"Type": "E30",
"Year": "1986-1991",
"id": 6
},
{
"Body": "Sedan with 4 doors; Coupe; Convertible",
"Engine_Type": "l6",
"Model": "M3",
"Power": "240 hp to 316 hp",
"Production_Number": "71,242",
"Type": "E36",
"Year": "1992-1999",
"id": 9
},
{
...
}
]
}
### /api/v1/cars/types/ -
#### Specify a model type to retrieve, where is the generation - ex. /api/v1/cars/types/e60
#### JSON Format - Array of Objects - if multiple matching values are returned, they will be in the form of an Array of Objects:
{
"type": [
{
"Body": "Coupe; Convertible",
"Engine_Type": "l6; V8",
"Model": "M3",
"Power": "337 hp to 374 hp",
"Production_Number": "85,744",
"Type": "E46",
"Year": "2000-2006",
"id": 12
},
{
...
}
]
}
### /api/v1/cars/ -
#### Specify a model type by ID - where is an integer based parameter - ex. /api/v1/cars/2
#### JSON Format - Object:
{
"response": [
{
"Body": "Sedan with 4 doors",
"Engine_Type": "l6",
"Model": "M535i",
"Power": "215 hp",
"Production_Number": "1,410",
"Type": "E12",
"Year": "1980-1984",
"id": 2
}
]
}