Skip to main content

Decoding APIs for product managers

Two men in a bar


Authentication


Endpoint


Method, Request and Response

Endpoint: http://theimaginaryyachtclubrestaurant.com/Menu?itemType=AllMethod: Get
Request Body:None
Response Body:
{
"data": [{
"itemtype": "Drinks",
"items": [
{
"name": "Margarita",
"price": "$ 15.95"
}
]
},
"itemtype": "Food",
{
"items": [
{
"name": "French Fries",
"price": "$ 10.95",
"flavour": "Salty"
},
{
"name": "Nachos",
"price": "$ 12.45",
"flavour": "spicy"
}
]
}
]
}
Endpoint:http://theimaginaryyachtclubrestaurant.com/NewDish/ 
Method:Post
Request Body:
{
'Content-Type': application/json'
'Accept': application/json'
'Data': {
'itemtype': 'Food',
'name' : 'vegan burger',
'price': '$ 18.50',
'flavour' : 'spicy'
}
}
Response Body:
HTTP/1.1 200 OK
Content-Type: application/jsonrequest
Endpoint:http://theimaginaryyachtclubrestaurant.com/VeganBurger/
Method:Put
Request Body:
{
'Content-Type': application/json'
'Accept': application/json'
'Data': {
'itemtype': 'Food',
'name' : 'vegan burger',
'price': '$ 10.50',
'flavour' : 'spicy'
}
}
Response Body:
HTTP/1.1 200 OK
Content-Type: application/jsonrequest
Endpoint:http://theimaginaryyachtclubrestaurant.com/RemoveDish
Method:Delete
Request Body:
{
'Content-Type': application/json'
'Accept': application/json'
'Data': {
'name' : 'caviar'
}
}
Response Body:
HTTP/1.1 200 OK
Content-Type: application/jsonrequest

API Status Codes and Error Messages