Dynamic Recipe Endpoints

Introduction: Enhancing User Experience with Dynamic Recipes

Welcome back! So far, you’ve learned how to build API endpoints that let users retrieve recipes, search by ingredients, and view recipe steps. These features are essential for any recipe app, but sometimes users want a little more excitement or guidance. For example, what if someone can’t decide what to cook and wants a random suggestion? Or maybe they want to see the most popular recipes based on ratings from other users. In this lesson, you’ll learn how to add two new features to your cooking helper API: An endpoint that returns a random recipe An endpoint that returns the most popular recipes based on user ratings These features make your app more interactive and helpful, giving users new ways to discover recipes.

Quick Recall: Retrieving and Filtering Recipes

Before we dive in, let’s quickly remind ourselves how we’ve been working with recipes so far. Previously, you built endpoints to: List all recipes with pagination (so users don’t get overwhelmed by too many results at once) Retrieve a single recipe by its ID Search for recipes by ingredients All of these endpoints use the routing and dependency injection features of the new tool and interact with the database using session objects. You’ve also learned how to format responses as dictionaries, which are automatically converted to JSON. Now, let’s build on these skills to add dynamic selection features.

Building the Random Recipe Endpoint

Let’s start by creating an endpoint that returns a random recipe . This is useful for users who want to try something new or can’t decide what to cook.

Step 1: Setting Up the Route

First, we need to define a new route. We’ll use the @router.get decorator to create a GET endpoint at /api/recipes/random . Python @router.get("/recipes/random", response_model=RecipeOut) def get_random_recipe(db: Session = Depends(get_db)): # Implementation will go here @router.get("/recipes/random", response_model=RecipeOut) def get_random_recipe(db: Session = Depends(get_db)): # Implementation will go here This sets up the endpoint, but it doesn’t do anything yet.

Step 2: Selecting a Random Recipe

To select a random recipe from the database, we use the order_by(func.random()) method. This tells the database to shuffle the recipes and pick the first one. Python recipe = db.query(Recipe).order_by(func.random()).first() recipe = db.query(Recipe).order_by(func.random()).first() db.query(Recipe) starts a query for all recipes. .order_by(func.random()) shuffles the order randomly. .first() picks the first recipe from the shuffled list. If there are no recipes in the database, recipe will be None .

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Python

@router.get("/recipes/random", response_model=RecipeOut)
def get_random_recipe(db: Session = Depends(get_db)):
    # Implementation will go here

Python

recipe = db.query(Recipe).order_by(func.random()).first()

Python

if not recipe:
    raise HTTPException(status_code=404, detail="No recipes found")

return serialize_recipe(recipe)

if not recipe:
    raise HTTPException(status_code=404, detail="No recipes found")

return serialize_recipe(recipe)

Python

@router.get("/recipes/random", response_model=RecipeOut)
def get_random_recipe(db: Session = Depends(get_db)):
    recipe = db.query(Recipe).order_by(func.random()).first()
    if not recipe:
        raise HTTPException(status_code=404, detail="No recipes found")
    return serialize_recipe(recipe)

@router.get("/recipes/random", response_model=RecipeOut)
def get_random_recipe(db: Session = Depends(get_db)):
    recipe = db.query(Recipe).order_by(func.random()).first()
    if not recipe:
        raise HTTPException(status_code=404, detail="No recipes found")
    return serialize_recipe(recipe)

JSON

{
  "id": 3,
  "name": "Spaghetti Carbonara",
  "ingredients": ["spaghetti", "eggs", "bacon", "parmesan"],
  "steps": "Boil pasta\nCook bacon\nMix eggs and cheese\nCombine all"
}

{
  "id": 3,
  "name": "Spaghetti Carbonara",
  "ingredients": ["spaghetti", "eggs", "bacon", "parmesan"],
  "steps": "Boil pasta\nCook bacon\nMix eggs and cheese\nCombine all"
}

Python

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    # Implementation will go here

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    # Implementation will go here

Python

subq = (
    db.query(
        Review.recipe_id.label("recipe_id"),
        func.avg(Review.rating).label("avg_rating"),
    )
    .group_by(Review.recipe_id)
    .subquery()
)

subq = (
    db.query(
        Review.recipe_id.label("recipe_id"),
        func.avg(Review.rating).label("avg_rating"),
    )
    .group_by(Review.recipe_id)
    .subquery()
)

Python

rows = (
    db.query(Recipe, subq.c.avg_rating)
    .join(subq, Recipe.id == subq.c.recipe_id)
    .order_by(subq.c.avg_rating.desc())
    .limit(10)
    .all()
)

rows = (
    db.query(Recipe, subq.c.avg_rating)
    .join(subq, Recipe.id == subq.c.recipe_id)
    .order_by(subq.c.avg_rating.desc())
    .limit(10)
    .all()
)

Python

return [
    RecipeDetail(
        **serialize_recipe(recipe).dict(),
        average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
    )
    for recipe, avg_rating in rows
]

return [
    RecipeDetail(
        **serialize_recipe(recipe).dict(),
        average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
    )
    for recipe, avg_rating in rows
]

Python

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    subq = (
        db.query(
            Review.recipe_id.label("recipe_id"),
            func.avg(Review.rating).label("avg_rating"),
        )
        .group_by(Review.recipe_id)
        .subquery()
    )

    rows = (
        db.query(Recipe, subq.c.avg_rating)
        .join(subq, Recipe.id == subq.c.recipe_id)
        .order_by(subq.c.avg_rating.desc())
        .limit(10)
        .all()
    )

    return [
        RecipeDetail(
            **serialize_recipe(recipe).dict(),
            average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
        )
        for recipe, avg_rating in rows
    ]

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    subq = (
        db.query(
            Review.recipe_id.label("recipe_id"),
            func.avg(Review.rating).label("avg_rating"),
        )
        .group_by(Review.recipe_id)
        .subquery()
    )

    rows = (
        db.query(Recipe, subq.c.avg_rating)
        .join(subq, Recipe.id == subq.c.recipe_id)
        .order_by(subq.c.avg_rating.desc())
        .limit(10)
        .all()
    )

    return [
        RecipeDetail(
            **serialize_recipe(recipe).dict(),
            average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
        )
        for recipe, avg_rating in rows
    ]

JSON

[
  {
    "id": 2,
    "name": "Chicken Alfredo",
    "ingredients": ["chicken", "pasta", "cream", "parmesan"],
    "steps": "Cook chicken\nBoil pasta\nMake sauce\nCombine all",
    "average_rating": 4.75
  },
  {
    "id": 5,
    "name": "Vegetable Stir Fry",
    "ingredients": ["broccoli", "carrots", "soy sauce", "rice"],
    "steps": "Chop veggies\nStir fry\nAdd sauce\nServe with rice",
    "average_rating": 4.5
  }
]

[
  {
    "id": 2,
    "name": "Chicken Alfredo",
    "ingredients": ["chicken", "pasta", "cream", "parmesan"],
    "steps": "Cook chicken\nBoil pasta\nMake sauce\nCombine all",
    "average_rating": 4.75
  },
  {
    "id": 5,
    "name": "Vegetable Stir Fry",
    "ingredients": ["broccoli", "carrots", "soy sauce", "rice"],
    "steps": "Chop veggies\nStir fry\nAdd sauce\nServe with rice",
    "average_rating": 4.5
  }
]

Python

if not recipe:
    raise HTTPException(status_code=404, detail="No recipes found")

return serialize_recipe(recipe)

Python

@router.get("/recipes/random", response_model=RecipeOut)
def get_random_recipe(db: Session = Depends(get_db)):
    recipe = db.query(Recipe).order_by(func.random()).first()
    if not recipe:
        raise HTTPException(status_code=404, detail="No recipes found")
    return serialize_recipe(recipe)

JSON

{
  "id": 3,
  "name": "Spaghetti Carbonara",
  "ingredients": ["spaghetti", "eggs", "bacon", "parmesan"],
  "steps": "Boil pasta\nCook bacon\nMix eggs and cheese\nCombine all"
}

Python

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    # Implementation will go here

Python

subq = (
    db.query(
        Review.recipe_id.label("recipe_id"),
        func.avg(Review.rating).label("avg_rating"),
    )
    .group_by(Review.recipe_id)
    .subquery()
)

Python

rows = (
    db.query(Recipe, subq.c.avg_rating)
    .join(subq, Recipe.id == subq.c.recipe_id)
    .order_by(subq.c.avg_rating.desc())
    .limit(10)
    .all()
)

Python

return [
    RecipeDetail(
        **serialize_recipe(recipe).dict(),
        average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
    )
    for recipe, avg_rating in rows
]

Python

@router.get("/recipes/popular", response_model=List[RecipeDetail])
def get_popular_recipes(db: Session = Depends(get_db)):
    subq = (
        db.query(
            Review.recipe_id.label("recipe_id"),
            func.avg(Review.rating).label("avg_rating"),
        )
        .group_by(Review.recipe_id)
        .subquery()
    )

    rows = (
        db.query(Recipe, subq.c.avg_rating)
        .join(subq, Recipe.id == subq.c.recipe_id)
        .order_by(subq.c.avg_rating.desc())
        .limit(10)
        .all()
    )

    return [
        RecipeDetail(
            **serialize_recipe(recipe).dict(),
            average_rating=round(float(avg_rating), 2) if avg_rating is not None else None
        )
        for recipe, avg_rating in rows
    ]

JSON

[
  {
    "id": 2,
    "name": "Chicken Alfredo",
    "ingredients": ["chicken", "pasta", "cream", "parmesan"],
    "steps": "Cook chicken\nBoil pasta\nMake sauce\nCombine all",
    "average_rating": 4.75
  },
  {
    "id": 5,
    "name": "Vegetable Stir Fry",
    "ingredients": ["broccoli", "carrots", "soy sauce", "rice"],
    "steps": "Chop veggies\nStir fry\nAdd sauce\nServe with rice",
    "average_rating": 4.5
  }
]

Introduction: Enhancing User Experience with Dynamic Recipes

Quick Recall: Retrieving and Filtering Recipes

Building the Random Recipe Endpoint

Step 1: Setting Up the Route

Step 2: Selecting a Random Recipe

Join the 1M+ learners on CodeSignal

Step 3: Returning the Recipe as a Response

Full Example

Building the Popular Recipes Endpoint

Step 1: Setting Up the Route

Step 2: Calculating Average Ratings

Step 3: Joining Recipes with Ratings and Sorting

Step 4: Formatting the Output

Full Example

Summary and What’s Next