Recipe Retrieval Endpoints
Introduction: The Role of Recipe Retrieval in Your App
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.
Recall: Express Routes and Prisma Models
Before we dive in, let’s briefly recall two key concepts you’ll use in this lesson: Express routes and Prisma models.
- Express 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 withID1. - Prisma models are TypeScript classes (defined in your Prisma schema) that represent tables in your database. For example, you might have a
Recipemodel for recipes and anIngredientmodel for ingredients. These models make it easy to query and update your database using TypeScript code.
You’ll see both of these concepts in action as we build the recipe retrieval endpoints.
Building the Single Recipe Endpoint
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.
Step 1: Defining the Route
In Express, you define a route using the router’s .get() method. Here’s how you set up a route to handle requests like /api/recipes/1:
- The
/:idpart means that this route will match any value in the URL and pass it to the function asreq.params.id. - The route only responds to
GETrequests because we are using.get().
