Route parameters in NestJS

Introduction

Route parameters let you capture parts of a URL to use in your code. This helps you handle dynamic data like user IDs or product names.

When you want to get a user ID from the URL to show that user's profile.

When you need to fetch a specific product based on its ID in the URL.

When you want to handle different pages or items using one route pattern.

When building REST APIs that require resource identifiers in the URL.

Syntax

NestJS

@Get(':parameterName')
methodName(@Param('parameterName') param: string) {
  // use param here
}

The colon : before the parameter name in the route path marks it as a variable.

The @Param() decorator extracts the parameter value from the URL.

Examples

This example captures the id from the URL and returns it as a string.

NestJS

@Get(':id')
getUser(@Param('id') id: string) {
  return `User ID is ${id}`;
}

Here, the route expects a URL like /product/123 and extracts 123 as productId.

NestJS

@Get('product/:productId')
getProduct(@Param('productId') productId: string) {
  return `Product ID: ${productId}`;
}

This example shows multiple route parameters in one URL, like /books/456.

NestJS

@Get(':category/:itemId')
getItem(
  @Param('category') category: string,
  @Param('itemId') itemId: string
) {
  return `Category: ${category}, Item ID: ${itemId}`;
}

Sample Program

This controller listens to URLs like /users/42. It extracts 42 as userId and returns a message with it.

NestJS

import { Controller, Get, Param } from '@nestjs/common';

@Controller('users')
export class UsersController {
  @Get(':userId')
  getUserById(@Param('userId') userId: string): string {
    return `User ID received: ${userId}`;
  }
}

Important Notes

Route parameters are always strings. Convert them if you need numbers.

You can use multiple parameters in one route to capture more data.

Be careful with parameter names; they must match between the route and the @Param() decorator.

Summary

Route parameters let you get dynamic parts of the URL.

Use : in the route path and @Param() to access them.

This helps build flexible and reusable routes in NestJS.

Practice

1. What does the : symbol represent in a NestJS route path like @Get('users/:id')?

easy

A. It is used to comment out the route path.

B. It defines a query parameter to be passed in the URL.

C. It indicates a static part of the URL path.

D. It marks id as a dynamic route parameter to capture from the URL.

Solution

1. Step 1: Understand route path syntax

   The colon : before id in @Get('users/:id') means id is a variable part of the URL.

2. Step 2: Identify the role of dynamic parameters

   This dynamic parameter allows the route to accept different id values from the URL, making the route flexible.

3. Final Answer:

   It marks id as a dynamic route parameter to capture from the URL. -> Option D

4. Quick Check:

   Colon means dynamic parameter = A [OK]

Hint: Colon before name means dynamic URL part [OK]

Common Mistakes:

• Thinking colon means query parameter
• Confusing static and dynamic parts
• Assuming colon is for comments

2. Which of the following is the correct way to access a route parameter named userId inside a NestJS controller method?

easy

A. @Body('userId') userId: string

B. @Query('userId') userId: string

C. @Param('userId') userId: string

D. @Headers('userId') userId: string

Solution

1. Step 1: Identify decorator for route parameters

   In NestJS, @Param() decorator is used to extract route parameters from the URL.

2. Step 2: Match parameter name

   Using @Param('userId') correctly accesses the userId parameter from the route.

3. Final Answer:

   @Param('userId') userId: string -> Option C

4. Quick Check:

   @Param for route params = C [OK]

Hint: Use @Param('name') to get route parameters [OK]

Common Mistakes:

• Using @Query instead of @Param for route params
• Trying to get route params from @Body or @Headers
• Forgetting to specify parameter name in @Param

3. Given this NestJS controller method:

@Get('products/:id')
getProduct(@Param('id') id: string) {
  return `Product ID is ${id}`;
}

What will be the response when a client requests /products/42?

medium

A. "Product ID is 42"

B. "Product ID is id"

C. "Product ID is undefined"

D. 404 Not Found error

Solution

1. Step 1: Understand route parameter extraction

   The @Param('id') decorator extracts the value 42 from the URL /products/42.

2. Step 2: Check returned string

   The method returns the string with the extracted id interpolated: "Product ID is 42".

3. Final Answer:

   "Product ID is 42" -> Option A

4. Quick Check:

   Route param 'id' = 42 in output [OK]

Hint: Route param value replaces :id in URL [OK]

Common Mistakes:

• Expecting literal 'id' instead of value
• Not using @Param to get the value
• Assuming undefined if param missing

4. What is wrong with this NestJS controller method?

@Get('orders/:orderId')
getOrder(@Param() orderId: string) {
  return `Order: ${orderId}`;
}

medium

A. Missing parameter name inside @Param() decorator.

B. Route path should not have colon before orderId.

C. Method should use @Query instead of @Param.

D. Return statement syntax is invalid.

Solution

1. Step 1: Check @Param usage

   The @Param() decorator without an argument returns an object of all params, not a single string.

2. Step 2: Identify mismatch in parameter type

   The method expects orderId as a string, but @Param() without argument returns an object, causing a type mismatch.

3. Final Answer:

   Missing parameter name inside @Param() decorator. -> Option A

4. Quick Check:

   @Param needs name for single param = B [OK]

Hint: Use @Param('name') for single param, else get object [OK]

Common Mistakes:

• Omitting parameter name in @Param() when expecting string
• Confusing @Param with @Query
• Thinking colon is wrong in route path

5. You want to create a NestJS route that accepts two parameters: category and itemId. Which of the following route paths and method signatures correctly captures both parameters?

hard

A. @Get('shop/:category/:itemId')getItem(@Body('category') category: string, @Body('itemId') itemId: string)

B. @Get('shop/:category/:itemId')getItem(@Param('category') category: string, @Param('itemId') itemId: string)

C. @Get('shop/:category/:itemId')getItem(@Query('category') category: string, @Query('itemId') itemId: string)

D. @Get('shop/:category/:itemId')getItem(@Param() params: string)

Solution

1. Step 1: Verify route path with two parameters

   The path 'shop/:category/:itemId' correctly defines two dynamic route parameters.

2. Step 2: Check method parameters for correct decorators

   Using @Param('category') and @Param('itemId') extracts each parameter individually as strings.

3. Final Answer:

   @Get('shop/:category/:itemId') with getItem(@Param('category') category: string, @Param('itemId') itemId: string) -> Option B

4. Quick Check:

   Use @Param('name') for each route param = D [OK]

Hint: Use @Param('name') for each route parameter [OK]

Common Mistakes:

• Using @Param() with string instead of object
• Using @Query or @Body instead of @Param for route params
• Not matching parameter names exactly