Why structured errors improve API quality in NestJS - Challenge Your Understanding

Challenge - 5 Problems

🧠 Conceptual

intermediate

Why use structured errors in APIs?

Which of the following best explains why structured errors improve API quality?

A They provide consistent error formats that help clients handle errors predictably.

B They reduce the size of API responses by removing error details.

C They allow APIs to ignore error handling on the client side.

D They make APIs run faster by skipping error checks.

💡 Hint

Think about how clients understand and react to errors.

Structured errors give a clear, consistent format for errors, making it easier for clients to detect and respond to problems.

❓ component_behavior

intermediate

Effect of structured errors on client behavior

Given a NestJS API that returns structured errors, what is the expected client behavior?

A Clients crash because errors are not handled.

B Clients ignore error responses and retry endlessly.

C Clients receive errors as plain text and cannot parse them.

D Clients can parse error codes and messages to show user-friendly alerts.

💡 Hint

Structured errors help clients understand what went wrong.

When errors are structured, clients can read error codes and messages to inform users properly or take corrective actions.

📝 Syntax

advanced

Correct way to throw a structured error in NestJS

Which option correctly throws a structured HTTP error with a custom message and status code in NestJS?

throw new ???('User not found', ???);

A HttpException, 'NOT_FOUND'

B HttpException, HttpStatus.NOT_FOUND

C HttpError, 404

D Error, 404

💡 Hint

Use NestJS built-in classes and enums for HTTP errors.

HttpException is the NestJS class for HTTP errors, and HttpStatus.NOT_FOUND is the enum for 404 status.

🔧 Debug

advanced

Identify the error in this structured error handling code

What error will this NestJS code produce?

throw new HttpException({ message: 'Invalid input' }, 400);

Assuming HttpException is imported correctly.

A No error; returns JSON with message and status 400

B TypeError because the first argument must be a string

C SyntaxError due to wrong object format

D Runtime error because status code 400 is invalid

💡 Hint

HttpException accepts either string or object as first argument.

HttpException can take an object as the response body, so this code returns a JSON error with message and status 400.

❓ lifecycle

expert

How structured errors integrate with NestJS exception filters

In NestJS, how do structured errors improve the behavior of custom exception filters?

A They prevent filters from catching errors, so errors propagate to the client raw.

B They force filters to ignore error messages and only use status codes.

C They allow filters to extract error details easily and format consistent responses.

D They make filters obsolete because errors are handled automatically.

💡 Hint

Think about how filters read error information.

Structured errors provide predictable data that filters can use to create uniform error responses and logging.

Practice

1. Why is it important to use structured errors in a NestJS API?

easy

A. They provide consistent and clear error messages for clients.

B. They make the API run faster by skipping error checks.

C. They hide error details to prevent debugging.

D. They automatically fix bugs in the code.

Solution

1. Step 1: Understand the role of structured errors

   Structured errors give clear, consistent feedback about what went wrong in the API.

2. Step 2: Identify the benefit for clients

   Clients get meaningful messages that help them understand and fix issues faster.

3. Final Answer:

   They provide consistent and clear error messages for clients. -> Option A

4. Quick Check:

   Clear error messages = A [OK]

Hint: Structured errors give clear feedback, not speed or auto-fixes [OK]

Common Mistakes:

• Thinking errors speed up the API
• Believing errors hide details always
• Assuming errors fix bugs automatically

2. Which of the following is the correct way to throw a structured HTTP error in NestJS?

easy

A. throw new HttpException({ message: 'Error occurred', status: 400 }, 400);

B. throw HttpException('Error occurred', 400);

C. throw new HttpException('Error occurred', 400);

D. throw new Error('HttpException', 400);

Solution

1. Step 1: Recall NestJS HttpException syntax

   HttpException constructor accepts a response object and a status code.

2. Step 2: Identify the correct structured error format

   Passing an object with message and status as the first argument is the proper way.

3. Final Answer:

   throw new HttpException({ message: 'Error occurred', status: 400 }, 400); -> Option A

4. Quick Check:

   HttpException with object and status = A [OK]

Hint: Use new HttpException({message, status}, code) syntax [OK]

Common Mistakes:

• Omitting 'new' keyword
• Passing string only without object
• Using generic Error instead of HttpException

3. Given this NestJS controller snippet, what will the client receive when getUser is called with an invalid ID?

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

@Controller('users')
export class UserController {
  @Get(':id')
  getUser(@Param('id') id: string) {
    if (id !== '123') {
      throw new HttpException({ error: 'User not found', code: 'USER_404' }, HttpStatus.NOT_FOUND);
    }
    return { id, name: 'Alice' };
  }
}

medium

A. "User not found" string with 404 status

B. { "error": "User not found", "code": "USER_404" } with 404 status

C. { "message": "User not found" } with 200 status

D. Empty response with 404 status

Solution

1. Step 1: Analyze the error thrown for invalid ID

   The code throws HttpException with an object containing error and code, and status 404.

2. Step 2: Understand the client response

   The client receives the JSON object with error details and HTTP 404 status.

3. Final Answer:

   { "error": "User not found", "code": "USER_404" } with 404 status -> Option B

4. Quick Check:

   Structured error object with 404 = B [OK]

Hint: HttpException sends object and status as response [OK]

Common Mistakes:

• Expecting plain string instead of object
• Assuming 200 status on error
• Missing error code in response

4. Identify the problem in this NestJS error handling code:

throw new HttpException('Invalid input', 400);

Why might this be less helpful for API clients?

medium

A. It should use a custom error class instead of HttpException.

B. It uses the wrong status code for invalid input.

C. It does not log the error to the console.

D. It throws a string instead of a structured object, limiting error details.

Solution

1. Step 1: Examine the error thrown

   The error is a simple string message without structure.

2. Step 2: Understand impact on API clients

   Clients get only a string, missing extra info like error codes or fields.

3. Final Answer:

   It throws a string instead of a structured object, limiting error details. -> Option D

4. Quick Check:

   String error limits details = C [OK]

Hint: Use objects for detailed errors, not plain strings [OK]

Common Mistakes:

• Confusing status code correctness
• Thinking custom classes are mandatory
• Ignoring logging importance here

5. You want to improve your NestJS API error responses by adding a timestamp and a unique error ID to every error. Which approach best uses structured errors to achieve this?

hard

A. Use try-catch blocks to catch errors and ignore timestamp and errorId.

B. Add console.log statements with timestamp and errorId before throwing errors.

C. Extend HttpException to include timestamp and errorId in the response object.

D. Throw plain strings with timestamp and errorId concatenated.

Solution

1. Step 1: Understand how to add extra info to errors

   Extending HttpException allows customizing the error response object with extra fields.

2. Step 2: Evaluate options for structured error enhancement

   Adding timestamp and errorId inside the error object keeps responses consistent and useful for clients.

3. Final Answer:

   Extend HttpException to include timestamp and errorId in the response object. -> Option C

4. Quick Check:

   Custom HttpException with extra fields = D [OK]

Hint: Customize HttpException to add fields, not just logs or strings [OK]

Common Mistakes:

• Thinking console logs affect API response
• Using plain strings loses structure
• Ignoring error details in catch blocks