Recipe lookup API for given n ingredients. This project is written to try out and learn Django and Django Rest Framework. The idea was to create an application that will provide you recipes from the current ingredients you have in the fridge.
All read operations are issued via get requests. Ingredients and seasonings are the parameters from which to filter the recipes.
- ingredients - these are the main ingredients the recipe requires.
- seasonings - spices, sauces, etc.
- match_any_level - the level of matching to apply on the results.
Currently, the API is live and hosted on pythonanywhere.com on this url: yev.pythonanywhere.com. Requests can all be done on the said server in real time. As of 5/10/2017 the database contains just test values. Issue a get request: yev.pythonanywhere.com/recipes/ to see current available recipes from which you can play around with.
Using only an ingredient parameter will perform exact matching on ingredients but any matching on seasoning. Lists should be delimited by the | character.
server-url/recipes?ingredients=Beef|Pork
This will pull up all recipes that only contain Beef and Pork regardless of what the seasonings are.
By default, the API performs an exact matching if no match_any_level parameter was given.
server-url/recipes?ingredients=Beef|Pork&seasonings=Ketchup|Mustard
This will fetch all recipes that only contains Beef and Pork as ingredients with Ketchup and Mustard as seasonings.
match_any_level parameter could have any of the following values: both, ingredients, seasonings
- both - matches any recipes that contains any of the given list of ingredients or seasonings.
server-url/recipes?ingredients=Beef|Pork&seasonings=Mustard|Ketchup&match_any_level=both
This will return all recipes that contains any of the following: Beef, Pork, Mustard, and Ketchup.
- ingredient - applies match any on ingredients but performs exact matching on seasonings.
server-url/recipes?ingredients=Beef|Pork&seasonings=Mustard|Ketchup&match_any_level=ingredient
This fetches only the recipes having both Mustard and Ketchup as seasoning but having a Pork OR Beef as its ingredients.
- seasonings - applies match any on seasonings but performs exact matching on ingredients.
server-url/recipes?ingredients=Beef|Pork&seasonings=Mustard|Ketchup&match_any_level=seasonings
Fetches only the recipes that contains both Pork and Beef having Mustard OR Ketchup as its seasonings.
Ingredients are mandatory, if one fails to add an ingredients parameter, the whole recipe list will be fetched regardless if there's a seasoning or match_any_level parameters.
