danistark1/recipesapi

API endpoints for https://github.com/PascaleStark

recipesapi's Issues

Commit saved records

add
$em->getConnection()->beginTransaction();
$em->getConnection()->commit();

to all saved records.

Add tagging

I should be able to add a comma separated tags when posting a recipe.

• new recipesTags table
• When posting the tags array to a recipe, check if the tag table already has the tag
• I should be able to search for a tag
• I can add up to 10 tags (validation)
• added tags are unique (validation)

Add: Search api

Add: Search api

Add validation class

Add validation class

Add directions parsing

Directions will be # separated, and will need to be split into an array.
Each array value will be a step.

Ex.

#Add 1 cup of water#Add 1 tsp of salt#Add 4 cups of flour

Should be parsed into
["Add 1 cup of water", "Add 1 tsp of salt", "Add 4 cups of flour"]

Project Plan

Tables

Recipes

• Name
• prep Time
• Cooking Time
• Servings
• Type (category)
• Directions (I should be able to store lists)
• Ingredients (will be comma separated)
• Added on (insertDateTime)
• Favorites (0 by default), I can add a recipe as a favorite.
• Added by (default empty string, might be used later)

Category

• Name
• Cuisine (Middle-Eastern, Canadian)
• Type (main course, side dish, deserts, breakfast)
• Added on (insertDateTime)

[Feature] Email a randomly selected recipe

send random meal idea on set days
Select meals of type main-dish, get all ids, them randomly select one of the ids
Email the selected recipe with its instructions to recipients

A selected meal should not be selected again until all other meals have been selected once.
For that, all selected meals should be placed in a new table, once all the meals have been selected, the table gets pruned.

Add: Patch API

Add: Patch API

Search: fulltext match

currently, when searching, we are doing a left/right wildcard match on any characters, it should be word match.

FrontEnd notes

• When posting a recipe, response code should be read
  • if response is 200, display success, otherwise display the response message from the api.
  • Modal should close
• Frontend Validation should conform to backend's, ex. frontend name should not exceed 100 characters.. (I can provide a table of field name/db structure)

On Mobile

You Cannot scroll to featured recipes

To Reproduce

On mobile, click on add recipe, close modal, then try to scroll down to featured recipes.

Add: GET category

Add: GET category

Directions parsing

I need to be able to parse titles.

Add: DELETE category

Add: DELETE category

Caching: Add PSR-6 cache

Add caching

Add: DELETE recipe

Add: DELETE recipe

Add: Recipes/Category Controller, Entity, Repository

Add:

• Recipes/Category Controller
• Entity
• Repository
• Table

API: Add image upload

API: Add image upload

[API] Category drop-down should be an api

Recipes categories drop-down should get the data from a BE API

[Validation]: Cooking time validation on save is # than on edit

On save 2 chars is is allowed and passes validation
On edit, the same recipe fails.

Add: GET:id recipe

Add: GET:id recipe

APIs

POST

Post a recipe

Field	Type	Required
name	String	Yes
prep_time	time	No
cooking_time	time	No
category	string	Yes
directions	text	Yes
ingredients	text	Yes
insert_date_time	datetime	Yes
favorites	Integer	Yes (should be default 0)
added_by	string	No
calories	string	No
cuisine	string	No
url	string	No

Sample POST

• http://localhost:8000/recipes

{
    "name": "pizza",
    "directions":"put in oven#eat",
    "ingredients": "1 tsp salt#2 tsp sugar",
    "category": "main_dish",
    "cuisine": "italian"
}

Sample response

[
    {
        "id": 3,
        "name": "pizza",
        "prepTime": null,
        "cookingTime": null,
        "servings": null,
        "category": "main_dish",
        "directions": "put in oven, eat",
        "insertDateTime": "2021-04-03 14:54:10",
        "favourites": 0,
        "addedBy": "",
        "calories": null,
        "cuisine": "italian",
        "ingredients": [
            "1 tsp salt",
            "2 tsp sugar"
        ],
        "url": null
    }
]

GetByName

• http://192.168.4.10:8300/recipes/name/{name}

GetWhere

• http://192.168.4.10:8000/recipes/where?{field=value}

ex. - http://192.168.4.10:8000/recipes/where?id=1

GetSearch

• http://localhost:8000/recipes/search?q={searchQuery}

Delete

http://localhost:8000/recipes/delete/{recipeID}

PUT

http://localhost:8000/recipes/update/1

{
    "name": "pizza4",
    "directions": "updated directions2",
    "category": "main_dish"
}

Get Category (Do we need this?)

I need to be able to get a list of categories

when adding a recipe, I have a drop-down that should have all the available categories.

Configuration: Add configuration

Add configuration structure

Directions UpperCase casing

Every direction step should be upper cased

POST: Rename name to title

POST API:

• Rename name field to title
• Rename added_by to publisher

Caching frontend assets

https://freecontent.manning.com/caching-assets/

[API] posting recipes with empty title

Details

You can post a recipes with spaces as title. This should be trimmed.

[API] Find all recipes

api endpoint to find all recipes filtered by category.
paginated results.

[Random Recipe Selector] prevent random selection of meals from same category

Details

Prevent selecting meals from same food category
Ex. Lemon Chicken Pasta & Chicken Pesto Pasta.

Possible fix

Add a sub-category to recipes_entity table

ex. category = Main Dish, sub_category = Pasta

Add: recipe POST

Add: recipe POST