Skip to content

Latest commit

 

History

History
271 lines (200 loc) · 8.84 KB

README.md

File metadata and controls

271 lines (200 loc) · 8.84 KB
Raw

Github

Remplr-backend

Node.js-based backend API for REMPLR 2.0

Overview

Introduction

The Recipe and Meal Plan API provides a comprehensive interface for managing recipes and meal plans within a nutrition and dietary application. The API is designed for use by administrators, nutritionists, and clients, and offers a range of features for creating, updating, deleting, and sharing recipes and meal plans.

Features

Ingredients Management

  • Create Ingredients: Authorized users can create new ingredients with all related details.
  • Retrieve Ingredients: Retrieve all or a specific ingredient's details, including ingredients and nutritional information.
  • Update Ingredients: Modify existing ingredients.
  • Delete Ingredients: Remove specific ingredients.

Recipes Management

  • Create Recipes: Authorized users can create new recipes with all related details.
  • Retrieve Recipes: Retrieve all or a specific recipe's details, including ingredients and nutritional information.
  • Update Recipes: Modify existing recipes.
  • Delete Recipes: Remove specific recipes.

Meal Plans Management

  • Create Meal Plans: Create meal plans that contain multiple recipes for different days and meal types.
  • Retrieve Meal Plans: View all meal plans or detailed information on a specific meal plan.
  • Update Meal Plans: Modify meal plans including adding or removing recipes.
  • Share Meal Plans: Nutritionists can share specific meal plans with clients.
  • Retrieve Shared Meal Plans: Clients can view meal plans shared with them.

Authorization

The API provides varying levels of access based on user roles. Specific endpoints require administrator or nutritionist authorization, while others may be accessed by logged-in users, including clients.

Base URL

If you want to run this project locally, the base URL is:

http://localhost:3001/

I’ll suggest using the following base URL which is already deployed:

https://remplr-backend.onrender.com/

REMPLR Design Architecture

REMPLR Design Architecture (4)

REMPLR Database Schema

REMPLR

Endpoints

Users:

1. User Authentication

POST /auth/token

  • Description: Authenticate a user.
  • Body:
    • username: Username of the user.
    • password: Password of the user.
  • Response:
    • { token }: JWT token which can be used to authenticate further requests.
  • Authorization required: None.
  • Status Code: Not specified (typically would be 200 OK).

2. Add a New Client for a Nutritionist

POST /auth/client/new

  • Description: Route to add a new client for a nutritionist.
  • Body:
    • username: Username of the client.
    • password: Password of the client.
    • firstName: First name of the client.
    • lastName: Last name of the client.
    • email: Email of the client.
    • nutritionist_username: Username of the associated nutritionist.
  • Response:
    • { message: Client ${clientId} is now linked to Nutritionist ${nutritionistId} }: Message indicating the client is now linked to a nutritionist.
  • Authorization required: Admin or Nutritionist.
  • Status Code: 201 Created.

3. Nutritionist Registration

POST /auth/register

  • Description: Registration route for nutritionists.
  • Body:
    • username: Username of the nutritionist.
    • password: Password of the nutritionist.
    • firstName: First name of the nutritionist.
    • lastName: Last name of the nutritionist.
    • email: Email of the nutritionist.
  • Response:
    • { token }: JWT token which can be used to authenticate further requests.
  • Authorization required: None.
  • Status Code: 201 Created.

Recipes

1. Create a new recipe

POST /recipes/

  • Description: Create a new recipe.
  • Body: JSON object containing recipe details.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing the created recipe.
  • Status Code: 201 Created.

2. Retrieve all recipes

GET /recipes/

  • Description: Retrieve all recipes.
  • Authorization: Admin or logged-in user.
  • Response: JSON object containing an array of recipes.
  • Status Code: 200 OK.

3. Retrieve a specific recipe

GET /recipes/:id

  • Description: Retrieve a specific recipe by ID.
  • Authorization: Admin or logged-in user.
  • Response: JSON object containing recipe details, including ingredients and nutrients.
  • Status Code: 200 OK.

4. Update a recipe

PATCH /recipes/:id

  • Description: Update a specific recipe by ID.
  • Body: JSON object containing update details.
  • Authorization: Admin.
  • Response: JSON object containing updated recipe.
  • Status Code: 200 OK.

5. Delete a recipe

DELETE /recipes/:id

  • Description: Delete a specific recipe by ID.
  • Authorization: Admin.
  • Response: JSON object containing deleted recipe ID.
  • Status Code: 200 OK.

Ingredients

1. Create a new ingredient

POST /ingredients/

  • Description: Create a new ingredient.
  • Body: JSON object containing ingredient details.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing the created ingredient.
  • Status Code: 201 Created.

2. Retrieve all ingredients

GET /ingredients/

  • Description: Retrieve all ingredients.
  • Authorization: Admin or logged-in user.
  • Response: JSON object containing an array of ingredients.
  • Status Code: 200 OK.

3. Retrieve a specific ingredient

GET /ingredients/:id

  • Description: Retrieve a specific ingredient by ID.
  • Authorization: Admin or logged-in user.
  • Response: JSON object containing ingredient details.
  • Status Code: 200 OK.

4. Update an ingredient

PATCH /ingredients/:id

  • Description: Update a specific ingredient by ID.
  • Body: JSON object containing update details.
  • Authorization: Admin.
  • Response: JSON object containing updated ingredient.
  • Status Code: 200 OK.

5. Delete an ingredient

DELETE /ingredients/:id

  • Description: Delete a specific ingredient by ID.
  • Authorization: Admin.
  • Response: JSON object containing deleted ingredient ID.
  • Status Code: 200 OK.

Meal Plans

Create a new meal plan

POST /

  • Description: Create a new meal plan.
  • Body: JSON object containing meal plan details and associated recipes.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing created meal plan.
  • Status Code: 201 Created.

Retrieve all meal plans

GET /

  • Description: Retrieve all meal plans.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing an array of meal plans.
  • Status Code: 200 OK.

Retrieve a specific meal plan

GET /:mealPlanId

  • Description: Retrieve a specific meal plan by ID.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing meal plan details.
  • Status Code: 200 OK.

Update a meal plan

PATCH /:mealPlanId

  • Description: Update a specific meal plan by ID.
  • Body: JSON object containing update details.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing updated meal plan.
  • Status Code: 200 OK.

Add a recipe to a meal plan

POST /:mealPlanId/recipes/:recipeId

  • Description: Add a recipe to a meal plan.
  • Body: JSON object containing recipe details.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing added recipe.
  • Status Code: 201 Created.

Remove a recipe from a meal plan

DELETE /:mealPlanId/recipes/:recipeId

  • Description: Remove a recipe from a meal plan.
  • Authorization: Admin or Nutritionist.
  • Response: JSON object containing deleted recipe ID.
  • Status Code: 200 OK.

Delete a meal plan

DELETE /:mealPlanId

  • Description: Delete a specific meal plan by ID.
  • Authorization: Admin.
  • Response: JSON object containing deleted meal plan ID.
  • Status Code: 200 OK.

Share a meal plan with a client

POST /:mealPlanId/share

  • Description: Share a meal plan with a client.
  • Body: JSON object containing nutritionist and client usernames.
  • Authorization: Admin or Nutritionist.
  • Response: Message confirming sharing.
  • Status Code: 200 OK.

Retrieve shared meal plans for a client

GET /shared/:clientUsername

  • Description: Retrieve shared meal plans for a client.
  • Authorization: Admin or Client.
  • Response: JSON object containing shared meal plans.
  • Status Code: 200 OK.