Recipes

About the Service

The application is just a simple multi-user RESTful service for kitchen recipes sharing. That allows to perform CRUD operations with recipes and provides Basic HTTP authentication. It uses a PostgreSQL database to store the data. You can also use any other relational database. If your database connection properties work, you can call some REST endpoints defined in localhost on port 8080. (see below)

How to Run

Clone this repository
Change the dir to the root of the project
Edit application.properties - set database info (db url, db driver, username, password, dialect)
Edit pom.xml if you use a DBMS other than postgreSQL (need to add jdbc-driver to the dependencies block)

Build :

mvn clean package

Run :

java -jar target/recipes-0.0.1-SNAPSHOT.jar

Allowed endpoints

User registration

POST /api/register

Accept: application/json
Content-Type: application/json

{
    "email" : "[email protected]",
    "password" : "example_password"
}

User authentification

To unlock the remaining endpoints, you need to log in using http basic auth. How it looks in Postman :

Create a recipe

POST /api/recipes/

Accept: application/json
Content-Type: application/json

{
"name": "Fresh Mint Tea",
   "category": "beverage",
   "description": "Light, aromatic and refreshing beverage, ...",
   "ingredients": ["boiled water", "honey", "fresh mint leaves"],
   "directions": ["Boil water", "Pour boiling hot water into a mug", "Add fresh mint leaves", "Mix and let the mint leaves seep for 3-5 minutes", "Add honey and mix again"]
}

Get all recipes sorted by update time

GET /api/recipes/

Update a recipe

PUT /api/recipes/{id}
Accept: application/json
Content-Type: application/json

{
   "name": "Warming Ginger Tea",
   "category": "beverage",
   "description": "Ginger tea is a warming drink for cool weather, ...",
   "ingredients": ["1 inch ginger root, minced", "1/2 lemon, juiced", "1/2 teaspoon manuka honey"],
   "directions": ["Place all ingredients in a mug and fill with warm water (not too hot so you keep the beneficial honey compounds in tact)", "Steep for 5-10 minutes", "Drink and enjoy"]
}

Delete a recipe by id

DELETE /api/recipes/{id}

Retrieve a recipe by id

GET /api/recipes/{id}

Search for recipes by name

GET /api/recipes/search/?name=Warming Ginder Tea

Search for recipes by category

GET /api/recipes/search/?category=beverage

cr1spet / recipes Goto Github PK

recipes's Introduction