Request body in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @Body() decorator in NestJS?

The @Body() decorator extracts the data sent in the request body, allowing the controller to access it as a JavaScript object.

intermediate

How do you define a DTO (Data Transfer Object) for validating request body data in NestJS?

A DTO is a TypeScript class that defines the shape and validation rules of the request body using decorators like <code>@IsString()</code> or <code>@IsInt()</code> from the <code>class-validator</code> package.

intermediate

What happens if the request body does not match the DTO validation rules in NestJS?

NestJS automatically returns a 400 Bad Request response with details about the validation errors, preventing the controller method from running.

beginner

How can you access only a specific property from the request body in a NestJS controller?

You can use @Body('propertyName') to extract just that property from the request body directly.

beginner

Why is it important to use DTOs and validation for request bodies in NestJS?

Using DTOs and validation helps keep your app safe by checking data before using it, avoiding errors and security issues from bad or unexpected input.

Which decorator is used to access the entire request body in a NestJS controller?

A @Param()

B @Body()

C @Query()

D @Headers()

The @Body() decorator extracts the whole request body.

What package is commonly used with NestJS to validate request body data?

A express-validator

B yup

C joi

D class-validator

NestJS uses class-validator with DTO classes for validation.

What HTTP status code does NestJS return if request body validation fails?

A 404 Not Found

B 200 OK

C 400 Bad Request

D 500 Internal Server Error

Validation errors cause a 400 Bad Request response.

How do you extract only the 'name' property from the request body in a NestJS controller?

A @Body('name')

B @Param('name')

C @Query('name')

D @Headers('name')

Use @Body('name') to get just the 'name' property.

Why should you use DTOs for request bodies in NestJS?

A To validate and structure incoming data

B To style the response

C To improve database speed

D To handle file uploads

DTOs help validate and organize incoming request data.

Explain how NestJS handles request body data and validation using decorators and DTOs.

Think about how data flows from the client to the controller and how NestJS checks it.

Describe the benefits of extracting specific properties from the request body in a NestJS controller.

Consider why you might want only part of the data instead of the whole object.

Practice

1. In NestJS, which decorator is used to access the data sent in the request body?

easy

A. @Body()

B. @Param()

C. @Query()

D. @Headers()

Solution

1. Step 1: Understand the purpose of decorators in NestJS

   Decorators like @Body(), @Param(), @Query(), and @Headers() extract different parts of the request.

2. Step 2: Identify which decorator accesses the request body

   @Body() specifically extracts the data sent in the request body from the client.

3. Final Answer:

   @Body() -> Option A

4. Quick Check:

   Request body data = @Body() [OK]

Hint: Request body data always uses @Body() decorator [OK]

Common Mistakes:

• Using @Param() to get body data
• Confusing @Query() with @Body()
• Trying to access body data without any decorator

2. Which of the following is the correct way to type the request body in a NestJS controller method?

easy

A. create(@Body: any data) {}

B. create(@Body data: any) {}

C. create(@Body() data: any) {}

D. create(@Body data) {}

Solution

1. Step 1: Recall the syntax for decorators with typed parameters

   In NestJS, the decorator is followed by parentheses and the parameter is typed after the colon.

2. Step 2: Check each option's syntax

   create(@Body() data: any) {} correctly uses @Body() with typed parameter 'data: any'. Options B, C, and D have syntax errors or missing parentheses.

3. Final Answer:

   create(@Body() data: any) {} -> Option C

4. Quick Check:

   Correct decorator syntax = create(@Body() data: any) {} [OK]

Hint: Always use parentheses with @Body() and type after colon [OK]

Common Mistakes:

• Omitting parentheses after @Body
• Placing type before parameter name
• Not typing the parameter at all

3. Given this NestJS controller method, what will be the output if the client sends {"name": "Alice"} in the request body?

  @Post()
  create(@Body() data: { name: string }) {
    return `Hello, ${data.name}!`;
  }

medium

A. "Hello, null!"

B. "Hello, undefined!"

C. Error: data.name is not defined

D. "Hello, Alice!"

Solution

1. Step 1: Understand the method behavior with typed body

   The method expects an object with a 'name' string property and returns a greeting using that name.

2. Step 2: Analyze the input and output

   The client sends {"name": "Alice"}, so data.name is "Alice". The method returns "Hello, Alice!".

3. Final Answer:

   "Hello, Alice!" -> Option D

4. Quick Check:

   Input name "Alice" produces greeting "Hello, Alice!" [OK]

Hint: Match input keys to typed properties for correct output [OK]

Common Mistakes:

• Assuming undefined if typing is missing
• Expecting runtime error for missing type
• Confusing property names in the body

4. Identify the error in this NestJS controller method:

  @Post()
  create(@Body data: { age: number }) {
    return `Age is ${data.age}`;
  }

medium

A. Return statement syntax error

B. Missing parentheses after @Body decorator

C. Incorrect type for data parameter

D. Method should be named differently

Solution

1. Step 1: Check the decorator syntax

   @Body decorator requires parentheses even if empty, so it should be @Body()

2. Step 2: Verify other parts of the method

   The type and return statement are correct; only the decorator syntax is wrong.

3. Final Answer:

   Missing parentheses after @Body decorator -> Option B

4. Quick Check:

   @Body() needs parentheses [OK]

Hint: Always write @Body() with parentheses, even if empty [OK]

Common Mistakes:

• Omitting parentheses after @Body
• Misplacing type annotation
• Assuming method name causes error

5. You want to accept a request body with optional fields in NestJS. Which method signature correctly types the body to allow optional 'email' and required 'username' fields?

  @Post()
  create(???) {
    // method body
  }

hard

A. @Body() data: { username: string; email?: string }

B. @Body() data: { username?: string; email: string }

C. @Body() data: { username: string; email: string }

D. @Body() data: { username?: string; email?: string }

Solution

1. Step 1: Understand optional and required fields in TypeScript types

   A question mark (?) after a property name means it is optional; absence means required.

2. Step 2: Match the requirement to the type

   Username is required, so no '?'. Email is optional, so it has '?'. @Body() data: { username: string; email?: string } matches this.

3. Final Answer:

   @Body() data: { username: string; email?: string } -> Option A

4. Quick Check:

   Required username, optional email = @Body() data: { username: string; email?: string } [OK]

Hint: Use '?' after optional fields in type definitions [OK]

Common Mistakes:

• Marking required fields as optional
• Marking optional fields as required
• Forgetting to use @Body() decorator