Get started

The DevLunch API provides you with recipes based on what you have at home. It can be used by anyone but targets developers looking for something to cook!

To use this API, you need to download the files or use the community edition.

Using the API

# Here is a simple example
GET http://localhost:3000/ingredients/bread
                

To get recipes with a specific ingredient, use this:
http://localhost:3000/ingredients/bread

Result example

{
   "_id":{
      "$oid":"607d1f7e4cb4890b1875b67c"
   },
   "name":"Bread Cake",
   "ingredients":[
      "Bread",
      "Candy",
      "More cake"
   ],
   "directions":"Eat",
   "created_date":""
}
                

QUERY PARAMETERS

Field	Type	Description
Ingredient Name	String	The ingredient you want recipes about. Use after /ingredients/:YOUR_INGREDIENT
Recipe ID	Mongo ID	The Mongo ID for recipes, it is found in the JSON response of every recipe, to navigate to a specific recipe, go to http://localhost:3000/recipes/:MONGO_ID

Errors

The DevLunch API uses standard status codes. These include 404, 500, etc. These are sent through res.status.