API Documentation

This project is built with Express and Mongoose. It has various API endpoints for authentication, users, recipes, categories, and subcategories. JWT tokens are managed via cookies and are required for many endpoints. All responses are returned in JSON format.

---

Installation and Running

• Clone the repository
  git clone <repo-url>

• Install dependencies
  npm install

• Create a .env file with the following variables:

  • PORT
  • MONGODB_URI
  • JWT_SECRET
  • NODE_ENV

• Start the server
  npm start

---

Auth Routes

POST /auth/signup

• What it does: Registers a new user.
• Required fields:
  • username (string)
  • email (string)
  • password (string)
  • name (string)
  • surname (string)
• Response: Returns a SIGNUP_SUCCESS message and sets a JWT cookie.

POST /auth/login

• What it does: Logs in a user.
• Required fields:
  • email (string)
  • password (string)
• Response: Returns a LOGIN_SUCCESS message and sets a JWT cookie.

GET /auth/logout

• What it does: Logs out the user.
• Response: Returns a LOGOUT_SUCCESS message.

---

Users Routes

GET /users/me

• What it does: Retrieves the current logged-in user’s information.
• Requires: A valid JWT cookie.
• Response: Returns the user object.

PUT /users/me

• What it does: Updates the current user's profile.
• Expected data:
  • username, name, surname, dob, profileImage, gender, bio, links
• Response: Returns a USER_UPDATED message.

GET /users/:user_id

• What it does: Retrieves a user by ID.
• Response: Returns the user object.

GET /users/:user_id/followers

• What it does: Lists the followers of a user.
• Response: Returns an array of followers.

GET /users/:user_id/followings

• What it does: Lists the users that the specified user is following.
• Response: Returns an array of followings.

GET /users/:user_id/follow

• What it does: Follows the specified user.
• Requires: A valid JWT cookie.
• Response: Returns a USER_FOLLOWED message.

GET /users/:user_id/unfollow

• What it does: Unfollows the specified user.
• Response: Returns a USER_UNFOLLOWED message.

---

Recipes Routes

GET /recipes

• What it does: Retrieves a list of recipes.
• Query Parameters:
  • page, limit, search, category, sub_category, author, cooking_devices, difficulty
  • preparing_time_min/max, cooking_time_min/max
  • nutrition_calories_min/max, etc.
• Response: Returns a list of recipes along with meta data (current page, total pages, etc.).

POST /recipes

• What it does: Creates a new recipe.
• Requires: A valid JWT cookie (user must be logged in).
• Required fields:
  • title
  • cooking_devices (array)
  • servings
  • preparing_time, cooking_time
  • description (optional)
  • nutrition (includes calories, protein, fat, carbs)
  • image_url, video, gallery
  • category, sub_category
• Additionally:
  • components (array)
  • informations (array)
  • instructions (array)
• Response: Returns a RECIPE_CREATED message and the newly created recipe object.

GET /recipes/:recipe_id

• What it does: Retrieves the details of a recipe by its ID.
• Response: Returns the recipe object with populated fields.

PUT /recipes/:recipe_id

• What it does: Updates an existing recipe.
• Requires: A valid JWT cookie and the user must be the owner of the recipe.
• Expected data: Updated recipe fields.
• Response: Returns a RECIPE_UPDATED message.

DELETE /recipes/:recipe_id

• What it does: Deletes a recipe.
• Requires: A valid JWT cookie and the user must be the owner of the recipe.
• Response: Returns a RECIPE_DELETED message.

GET /recipes/:user_id/:recipe_slug

• What it does: Retrieves a recipe by user ID and its slug.
• Response: Returns the recipe object.

---

Recipe Related Sub-Endpoints

Components:

• POST /recipes/:recipe_id/components
  • Adds a new component.
• PUT /recipes/:recipe_id/components/:component_id
  • Updates a component.
• DELETE /recipes/:recipe_id/components/:component_id
  • Deletes a component.

Informations:

• POST /recipes/:recipe_id/informations
  • Adds additional information.
• PUT /recipes/:recipe_id/informations/:information_id
  • Updates the information.
• DELETE /recipes/:recipe_id/informations/:information_id
  • Deletes the information.

Instructions:

• POST /recipes/:recipe_id/instructions
  • Adds an instruction.
• PUT /recipes/:recipe_id/instructions/:instruction_id
  • Updates an instruction.
• DELETE /recipes/:recipe_id/instructions/:instruction_id
  • Deletes an instruction.

Comments & Replies:

• POST /recipes/:recipe_id/comments
  • Adds a comment.
• PUT /recipes/:recipe_id/comments/:comment_id
  • Updates a comment.
• DELETE /recipes/:recipe_id/comments/:comment_id
  • Deletes a comment.
• POST /recipes/:recipe_id/comments/:comment_id/replies
  • Adds a reply to a comment.
• PUT /recipes/:recipe_id/comments/:comment_id/replies/:reply_id
  • Updates a reply.
• DELETE /recipes/:recipe_id/comments/:comment_id/replies/:reply_id
  • Deletes a reply.

Rating:

• POST /recipes/:recipe_id/rate
  • Rates the recipe.
• GET /recipes/:recipe_id/my-rating
  • Retrieves the user's rating for the recipe.

Bookmark:

• GET /recipes/:recipe_id/my-bookmark
  • Checks if the recipe is bookmarked by the user.
• POST /recipes/:recipe_id/bookmark
  • Toggles the bookmark for the recipe.

---

Categories Routes

GET /categories

• What it does: Retrieves all categories.
• Response: Returns an array of categories.

POST /categories

• What it does: Creates a new category.
• Requires: A valid JWT cookie.
• Required fields:
  • name (mandatory)
  • description (optional)
  • imageUrl (optional)
• Response: Returns a CATEGORY_CREATED message.

GET /categories/:category_id

• What it does: Retrieves a category by its ID.
• Response: Returns the category object.

DELETE /categories/:category_id

• What it does: Deletes a category.
• Requires: A valid JWT cookie.
• Response: Returns a CATEGORY_DELETED message.

GET /categories/slug/:category_slug

• What it does: Retrieves a category by its slug.
• Response: Returns the category object.

GET /categories/:category_id/subcategories

• What it does: Retrieves subcategories for a given category ID.
• Response: Returns an array of subcategories.

GET /categories/slug/:slug/subcategories

• What it does: Retrieves subcategories for a category using its slug.
• Response: Returns an array of subcategories.

PUT /categories/:category_id

• What it does: Updates a category.
• Requires: A valid JWT cookie.
• Expected data: Updated category fields.
• Response: Returns a CATEGORY_UPDATED message.

---

Subcategories Routes

GET /subcategories

• What it does: Retrieves all subcategories.
• Response: Returns an array of subcategories.

POST /subcategories

• What it does: Creates a new subcategory.
• Requires: A valid JWT cookie.
• Required fields:
  • name
  • description
  • image_url
  • category_id
• Response: Returns a SUBCATEGORY_CREATED message.

GET /subcategories/:subcategory_id

• What it does: Retrieves a subcategory by its ID.
• Response: Returns the subcategory object.

DELETE /subcategories/:subcatagory_id

• What it does: Deletes a subcategory.
  Note: The parameter name might sometimes be "subcatagory_id".
• Requires: A valid JWT cookie.
• Response: Returns a SUBCATEGORY_DELETED message.

PUT /subcategories/:subcategory_id

• What it does: Updates a subcategory.
• Requires: A valid JWT cookie.
• Expected data: Updated subcategory fields.
• Response: Returns a SUBCATEGORY_UPDATED message.

GET /subcategories/slug/:slug

• What it does: Retrieves a subcategory by its slug.
• Response: Returns the subcategory object.

---

Error Handling

• All error responses are returned in JSON format.
• The error object includes an error.code and error.message.
• Error codes and messages are fetched from a texts.json file.

---

Authentication & Validation

• Protected endpoints require a valid JWT cookie.
• Input data is validated via middleware.
• User roles can be enforced with role-check middleware (checkRoles).

---

Notes

• All sent data must be in the correct format.
• Query parameters and request bodies are validated.
• Some endpoints use transactions (Mongoose sessions) for data integrity.

---

License

MIT

---

This documentation serves as a basic reference for using the API. Example requests and responses can be tested using your preferred API testing tool.

Happy coding!