Docker must be installed on your machine
-
Clone the repo locally
git clone [email protected]:Omar-kh/inventory-backend.git
-
Go into the folder
cd inventory-backend
-
Build the docker container (may take some time, make sure you have an Internet connection):
sudo docker build -t inventory-backend .
-
Run the container
sudo docker run -d -p 5000:5000 inventory-backend
That's it. Your API should be running on your machine on port 5000
The API has two endpoints :
Supposing your are on localhost:
http://localhost:5000/inventory
==> Returns a list of products with their ids and names
[
{
"product_id": "9f0d518206",
"product_name": "Product_1"
},
{
"product_id": "6fd7aaa08a",
"product_name": "Product_2"
},
...
]
http://localhost:5000/inventory/${product_id}
==> Returns inventory values of the requested product over time
{
"product_id": "9f0d518206",
"product_name": "Product_1",
"dates": [
"2019-07-01",
"2019-07-02",
"2019-07-03",
"2019-07-04",
"2019-07-05",
...
],
"values": [
9641,
181,
908,
6536,
2983,
...
]
}