# ***Homely Flavors API*** Welcome to the Homely Flavors API! This API provides access to a collection of cooking recipes from various categories. You can retrieve recipe details, including ingredients, preparation instructions, and associated images. The API is organized around REST principles and returns data in JSON format. Base URL The base URL for the API is: https://flavorsapi.vercel.app/flavors/api Endpoints 1. Retrieve All Recipes GET /recipes Returns all the available recipes in the database. ### Request http GET /recipes Host: https://flavorsapi.vercel.app/flavors/api Response Status: 200 OK Body: JSON array containing all recipes, each with the following fields: id: Unique identifier of the recipe title: Name of the recipe ingredients: List of ingredients required instructions: Step-by-step instructions for preparation image: URL to the image of the recipe category: The category to which the recipe belongs created_at: Timestamp when the recipe was added ## Example Response(Not real data): **json**

[
  {
    "id": 1,
    "title": "Salata",
    "ingredients": ["Tomatoes", "Cucumbers", "Onions", "Olive Oil", "Salt"],
    "instructions": "Chop all vegetables and mix with olive oil and salt.",
    "image": "https://linktoimage.com/salata.jpg",
    "category": "Salads",
    "created_at": "2024-08-12T14:48:00Z"
  },
  {
    "id": 2,
    "title": "Grilled Chicken",
    "ingredients": ["Chicken Breast", "Olive Oil", "Lemon", "Garlic", "Spices"],
    "instructions": "Marinate the chicken and grill on medium heat.",
    "image": "https://linktoimage.com/grilled_chicken.jpg",
    "category": "Meat",
    "created_at": "2024-08-10T12:00:00Z"
  }
]

2. Retrieve a Single Recipe by Name GET /recipes/{recipe-name} Fetches a specific recipe by its name (e.g., salata). ### Request http GET /recipes/salata Host: https://flavorsapi.vercel.app/flavors/api Response Status: 200 OK Body: JSON object containing details of the requested recipe. ## Example Response: **json**

{
  "id": 1,
  "title": "Salata",
  "ingredients": ["Tomatoes", "Cucumbers", "Onions", "Olive Oil", "Salt"],
  "instructions": "Chop all vegetables and mix with olive oil and salt.",
  "image": "https://linktoimage.com/salata.jpg",
  "category": "Salads",
  "created_at": "2024-08-12T14:48:00Z"
}

3. Retrieve Recipes by Category GET /recipes/category/{category-name} Fetches all recipes within a specified category. ### Request http GET /recipes/category/meat Host: https://flavorsapi.vercel.app/flavors/api Response Status: 200 OK Body: JSON array of recipes in the specified category. ## Example Response: **json**

[
  {
    "id": 2,
    "title": "Grilled Chicken",
    "ingredients": ["Chicken Breast", "Olive Oil", "Lemon", "Garlic", "Spices"],
    "instructions": "Marinate the chicken and grill on medium heat.",
    "image": "https://linktoimage.com/grilled_chicken.jpg",
    "category": "Meat",
    "created_at": "2024-08-10T12:00:00Z"
  }
]

Error Handling The API uses standard HTTP status codes to indicate success or failure of requests. 200 OK – The request was successful, and the response contains the requested data. 400 Bad Request – The request was invalid or missing required parameters. 404 Not Found – The requested resource was not found. 500 Internal Server Error – The server encountered an error. Example Error Response: json

{
  "error": "Recipe not found"
}

Data Formats All data is returned in JSON format. Time and date fields are returned in ISO 8601 format. Authentication Currently, the API does not require authentication and is publicly accessible. Usage Example You can use curl or any HTTP client to make requests to the API. Example with curl bash Copy code curl https://flavorsapi.vercel.app/flavors/api/recipes/salata Example with Python (using requests library) python

import requests

url = "https://flavorsapi.vercel.app/flavors/api/recipes/salata"
response = requests.get(url)

if response.status_code == 200:
    recipe = response.json()
    print(recipe)

else:
    print("Error:", response.status_code)

Future Features Authentication: Adding token-based authentication for secure access. Pagination: Implementing pagination for retrieving large datasets. Search: Enabling search functionality for more efficient recipe queries. User Contributions: Allowing users to submit their own recipes. Contributing Contributions to the API are welcome! If you'd like to report an issue or request a feature, feel free to submit an issue on the GitHub repository. This documentation will help users effectively interact with your API while providing clear examples and usage instructions.