Why structured errors improve API quality in NestJS - Quick Recap

Recall & Review

beginner

What are structured errors in the context of APIs?

Structured errors are error responses formatted in a consistent and predictable way, usually as JSON objects with specific fields like 'code', 'message', and 'details'. This helps clients understand and handle errors easily.

beginner

How do structured errors improve API client experience?

They provide clear, consistent information about what went wrong, allowing clients to show helpful messages or take specific actions instead of guessing or failing silently.

intermediate

Why is consistency important in API error responses?

Consistency means every error looks similar, so developers don’t have to write special code for different errors. This reduces bugs and speeds up development.

intermediate

What role do error codes play in structured errors?

Error codes give a quick way to identify the type of error programmatically, making it easier for clients to react correctly without parsing long messages.

beginner

How can NestJS help implement structured errors?

NestJS provides built-in exception filters and HTTP exceptions that let you define and throw structured errors easily, ensuring your API responses are uniform and clear.

What is a key benefit of using structured errors in APIs?

A Clients can easily understand and handle errors

B Errors are hidden from clients

C Errors are always logged to the console

D Errors are ignored by the server

Structured errors provide clear information that clients can use to handle problems properly.

Which field is commonly included in a structured error response?

A sessionId

B password

C username

D code

The 'code' field helps identify the error type in a structured error.

Why should API errors be consistent in format?

A To reduce client-side error handling complexity

B To confuse developers

C To increase server load

D To hide error details

Consistency makes it easier for clients to handle errors without special cases.

In NestJS, what feature helps create structured error responses?

A Guards

B Middleware

C Exception filters

D Interceptors

Exception filters catch errors and format them into structured responses.

What does a structured error's 'message' field usually contain?

A The user's password

B A human-readable explanation of the error

C The server's IP address

D The current date and time

The 'message' explains what went wrong in a way users or developers can understand.

Explain why structured errors are important for API quality and how they help both developers and users.

Think about how predictable error responses help avoid confusion.

Describe how NestJS supports creating structured error responses in an API.

Focus on NestJS features that catch and format errors.

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