Recipe Retrieval Endpoints

Welcome to the first lesson of the Building the Recipe API course! In this lesson, you will learn how to build the core endpoints that allow your app to fetch recipes and their details from a database.

Recipe retrieval is a fundamental feature of any cooking helper app. Users need to be able to look up recipes, see what ingredients are required, and follow the steps to cook a dish. By the end of this lesson, you will know how to create endpoints that return a single recipe by its ID and a list of recipes with pagination. These skills are the foundation for more advanced features you’ll add later, such as searching, filtering, and user reviews.

Before we dive in, let’s briefly recall two key concepts you’ll use in this lesson: API routes and database models.

• API routes are functions that respond to specific URLs in your web application. For example, when a user visits /api/recipes/1, a route function will handle that request and return the recipe with ID 1.
• Database models are classes that represent tables in your database. For example, you might have a Recipe model for recipes and a Review model for user reviews. These models make it easy to query and update your database using Python code.

You’ll see both of these concepts in action as we build the recipe retrieval endpoints.

Let’s start by building an endpoint that returns a single recipe by its ID. This is useful when a user wants to view the details of a specific recipe.

You define a route using a decorator. Here’s how you set up a route to handle requests like /api/recipes/1:

@router.get("/recipes/{recipe_id}", response_model=RecipeDetail)
def get_recipe(recipe_id: int, db: Session = Depends(get_db)):
    # Function body will go here

• The {recipe_id} part means that this route will match any integer value in the URL and pass it to the function as recipe_id.
• The response_model=RecipeDetail part ensures the response is formatted according to the RecipeDetail schema.