| Lou | Catherine | Yurika |
|---|---|---|
 |
 |
 |
 |
|
|
To get the server running locally:
- Clone this repo
- npm i to install all required dependencies
- npm run server to start the local server
- npm run test to start server using testing environment
- NodeJS
- Express
- KnexJS
- Postgres
URL: "baseURL/users/register/",
Method: POSTAllows a user to register.
Required Fields:
- Username
- Password
Example Successful Response:
{
"message": "Welcome, new user.",
"user": {
"id": 8,
"username": "Testing35"
},
"token": {
"token": "user token",
"expiration_date": "2020-01-24T19:30:44.000Z"
}
}URL: "baseURL/users/login/",
Method: POSTAllows a user to login.
Required Fields:
- Username
- Password
Example Successful Response:
{
"message": "Welcome, new user.",
"user": {
"id": 8,
"username": "Testing35"
},
"token": {
"token": "user token",
"expiration_date": "2020-01-24T19:30:44.000Z"
}
}URL: "baseURL/recipes?title=c"
method: GETGets all Recipes from the database.
Search Query: Search by Title
Example Response:
res.data:
[
{
"id": 3,
"title": "Scrambled Eggs",
"description": null,
"forked_from": null,
"owner": {
"user_id": 2,
"username": "Lou"
}
},
{
"id": 2,
"title": "Cereal",
"description": null,
"forked_from": null,
"owner": {
"user_id": 1,
"username": "Catherine"
}
}
]URL: "baseURL/recipes/1"
method: GETGets one Recipe from the database, with ingredients, instructions, tags, and notes.
Request Params: id of the single recipe to receive
Example Response:
res.data:
{
"id": 1,
"title": "Eggplant",
"description": null,
"forked_from": null,
"prep_time": null,
"cook_time": 15,
"img": "https://image.shutterstock.com/image-photo/grilled-eggplants-seasoned-olive-oil-260nw-87708241.jpg",
"owner": {
"user_id": 2,
"username": "Lou"
},
"ingredients": [
{
"name": "eggplant",
"units": "whole",
"quantity": 1,
"units_short": null,
"recipe_ingredients_id": 1
}
],
"instructions": [
{
"id": 1,
"description": "take eggplant",
"step_number": 1
},
{
"id": 2,
"description": "cook eggplant",
"step_number": 2
},
{
"id": 3,
"description": "eat eggplant",
"step_number": 3
}
],
"tags": [
{
"id": 1,
"name": "Breakfast"
},
{
"id": 2,
"name": "Brunch"
}
],
"notes": [
{
"id": 1,
"description": "Eggplant is healthy."
},
{
"id": 2,
"description": "Edit recipe to add parmesan"
}
]
}URL: "baseURL/cookbook?course=breakfast"
method: GETGets all Recipes linked to the logged user.
Search Query: Search by course
Example Response:
res.data:
[
{
"id": 3,
"title": "Scrambled Eggs",
"description": null,
"forked_from": null,
"owner": {
"user_id": 2,
"username": "Lou"
}
},
{
"id": 1,
"title": "Eggplant",
"description": null,
"forked_from": null,
"owner": {
"user_id": 2,
"username": "Lou"
}
},
{
"id": 2,
"title": "Cereal",
"description": null,
"forked_from": null,
"owner": {
"user_id": 1,
"username": "Catherine"
}
}
]URL: "baseURL/recipes/"
method: POSTAdds a new recipe to the database.
Required Fields:
- Title
- Either prep_time or cook_time
- Tags (Array of strings)
- Ingredients (Array of objects)
- Instructions (Array of objects)
- Author Comment (string)
Optional Fields:
- Description (recipe description)
- Notes (Array of Strings)
- prep_time or cook_time (Can have both properties)
- img (url linking to a recipe image)
Example Request:
req.body:
{
"title": "Eggplant",
"description": null,
"forked_from": null,
"prep_time": null,
"cook_time": 15,
"img": "https://image.shutterstock.com/image-photo/grilled-eggplants-seasoned-olive-oil-260nw-87708241.jpg",
"ingredients": [
{
"name": "eggplant",
"units": "whole",
"quantity": 1
}
],
"instructions": [
{
"description": "take eggplant",
"step_number": 1
},
{
"description": "cook eggplant",
"step_number": 2
},
{
"description": "eat eggplant",
"step_number": 3
}
],
"tags": [
"Breakfast",
"Brunch"
],
"notes": [
"Eggplant is healthy.",
"Edit recipe to add parmesan"
],
"author_comment": "New Recipe"
}Example Response:
res.data:
{
"previous_versions_count": "0",
"id": 48,
"title": "Eggplant",
"description": null,
"forked_from": null,
"prep_time": null,
"cook_time": 15,
"img": "https://image.shutterstock.com/image-photo/grilled-eggplants-seasoned-olive-oil-260nw-87708241.jpg",
"author_comment": "New Recipe",
"date_modified": "2020-01-29T19:03:52.701Z",
"owner": {
"user_id": 1,
"username": "Catherine"
},
"ingredients": [
{
"name": "eggplant",
"units": "whole",
"quantity": 1,
"units_short": null,
"recipe_ingredients_id": 116
}
],
"instructions": [
{
"id": 47,
"description": "take eggplant",
"step_number": 1
},
{
"id": 48,
"description": "cook eggplant",
"step_number": 2
},
{
"id": 49,
"description": "eat eggplant",
"step_number": 3
}
],
"tags": [
{
"id": null,
"name": null
}
],
"notes": [
{
"id": 19,
"description": "Eggplant is healthy."
},
{
"id": 20,
"description": "Edit recipe to add parmesan"
}
]
}URL: "baseURL/recipes/1"
method: PUTUpdates an existing recipe in the database.
Required Fields:
- Title
- Either prep_time or cook_time
- Tags (Array of strings)
- Ingredients (Array of objects)
- Instructions (Array of objects)
Optional Fields:
- Description (recipe description)
- Notes (Array of Strings)
- prep_time or cook_time (Can have both properties)
- img (url linking to a recipe image)
| Differences from a POST request: |
|---|
Existing ingredients need their id included in the object |
Existing notes need their id included in the object |
Existing tags need their id included in the object |
Existing instructions don't need their id included in the object |
New entries do not need an id |
Example Request:
req.body:
{
"id": 1,
"title": "Eggplant",
"cook_time": 15,
"ingredients": [
{
"name": "eggplant",
"units": "whole",
"quantity": 1,
"units_short": null,
"recipe_ingredients_id": 1
},
{
"name": "parmesan",
"units": "cup",
"quantity": 0.5
}
],
"instructions": [
{
"id": 1,
"description": "takem eggplant",
"step_number": 1
},
{
"id": 2,
"description": "cook eggplant",
"step_number": 2
},
{
"description": "EATEM",
"step_number": 3
}
],
"tags": [
{
"id": 1,
"name": "breakfast"
},
{
"id": 2,
"name": "brunch"
}
],
"notes": [
{
"id": 1,
"description": "Eggplants are healthy."
},
{
"id": 2,
"description": "Edit the recipe recipe to add parmesan"
},
{
"description": "new note"
}
]
}URL: "baseURL/recipes/1"
method: DELETEAllows a logged in user that owns the recipe to delete it from the database.
Example Response:
res.data
;("Recipe Name has been terminated.")URL: "baseURL/recipes/1/versions/"
method: GETGets all versions of a recipe by the recipe's id.
Example Response:
res.data:
;[
// First one in the array is the most current version of the recipe.
{
revision_number: 14,
changes: {
previous_versions_count: "13",
id: 5,
title: "This is a recipe edited TEST!!!!",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Does this return current version?\n",
date_modified: "2020-01-27T22:35:20.845Z",
owner: {
user_id: 5,
username: "Testing123"
},
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 66
}
],
instructions: [
{
id: 18,
description: "Test!!!!",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
date_modified: "2020-01-27T22:35:20.845Z"
},
{
id: 3,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: null,
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 17
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 1,
date_modified: "2020-01-27T22:35:35.125Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 4,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Edited recipe",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 18
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 2,
date_modified: "2020-01-27T22:37:39.146Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 5,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited another one",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Another one!",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 19
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 3,
date_modified: "2020-01-27T22:38:13.029Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 6,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited FOUR",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Four",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 20
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 4,
date_modified: "2020-01-27T22:42:46.678Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 7,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited FIVE",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Test",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 21
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 5,
date_modified: "2020-01-28T17:47:07.168Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 8,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited FIVE!",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 22
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 6,
date_modified: "2020-01-28T17:48:52.207Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 10,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited FIVE!!!",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 23
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 7,
date_modified: "2020-01-28T17:49:24.728Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 11,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited TEST",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 26
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 8,
date_modified: "2020-01-28T17:49:45.436Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 13,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited TEST!!!",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 27
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 9,
date_modified: "2020-01-28T17:51:32.208Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 14,
recipe_id: 5,
changes: {
id: 5,
title: "This is a recipe edited TEST!!! Test",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Test",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 30
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 10,
date_modified: "2020-01-28T17:51:51.424Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 24,
recipe_id: 5,
changes: {
previous_versions_count: "10",
id: 5,
title: "This is a recipe edited TEST!!! Test",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Testing",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 31
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 11,
date_modified: "2020-01-28T21:12:23.002Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 25,
recipe_id: 5,
changes: {
previous_versions_count: "11",
id: 5,
title: "This is a recipe that I changed!",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "I changed this",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 54
}
],
instructions: [
{
id: 18,
description: "Test",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 12,
date_modified: "2020-01-28T21:15:33.498Z",
owner: {
user_id: 5,
username: "Testing123"
}
},
{
id: 27,
recipe_id: 5,
changes: {
previous_versions_count: "12",
id: 5,
title: "This is a recipe edited TEST",
description: null,
forked_from: null,
prep_time: 1,
cook_time: 1,
img: null,
author_comment: "Test",
date_modified: "2020-01-27T22:35:20.845Z",
ingredients: [
{
name: "1",
units: "teaspoon",
quantity: 1,
units_short: "tsp",
recipe_ingredients_id: 55
}
],
instructions: [
{
id: 18,
description: "Test!!!!",
step_number: 1
}
],
tags: [
{
id: 1,
name: "Breakfast"
}
],
notes: [
{
id: 7,
description: "Test"
}
]
},
revision_number: 13,
date_modified: "2020-01-28T21:55:37.417Z",
owner: {
user_id: 5,
username: "Testing123"
}
}
]URL: "baseURL/recipes/1/version/1"
method: GETGets a single revision based on the revision id.
Example Response
res.data:
{
"id": 4,
"recipe_id": 5,
"changes": {
"id": 5,
"title": "This is a recipe edited",
"description": null,
"forked_from": null,
"prep_time": 1,
"cook_time": 1,
"img": null,
"author_comment": "Edited recipe",
"ingredients": [
{
"name": "1",
"units": "teaspoon",
"quantity": 1,
"units_short": "tsp",
"recipe_ingredients_id": 18
}
],
"instructions": [
{
"id": 18,
"description": "Test",
"step_number": 1
}
],
"tags": [
{
"id": 1,
"name": "Breakfast"
}
],
"notes": [
{
"id": 7,
"description": "Test"
}
]
},
"revision_number": 2,
"date_modified": "2020-01-27T22:37:39.146Z",
"owner": {
"user_id": 5,
"username": "Testing123"
}
}URL: "baseURL/recipes/1/versions/2"
method: GETGets a single revision based on the revision number.
Example Response:
res.data:
{
"id": 1,
"recipe_id": 2,
"changes": {
"id": 2,
"title": "Cereal",
"description": null,
"forked_from": null,
"prep_time": 45,
"cook_time": null,
"img": "https://image.shutterstock.com/z/stock-photo-cornflakes-with-milk-in-the-white-bowl-322906217.jpg",
"ingredients": [
{
"name": null,
"units": null,
"quantity": null,
"units_short": null,
"recipe_ingredients_id": null
}
],
"instructions": [
{
"id": null,
"description": null,
"step_number": null
}
],
"tags": [
{
"id": null,
"name": null
}
],
"notes": [
{
"id": null,
"description": null
}
]
},
"date_modified": "2020-01-21T22:11:10.950Z",
"revision_number": 1,
"author_comment": null
}