Why structured errors improve API quality in NestJS - Visual Breakdown

Concept Flow - Why structured errors improve API quality

API receives request

↓

Process request logic

↓

Error occurs?

No→Return success response

Yes↓

Create structured error object

↓

Send structured error response

↓

Client receives clear error info

The API processes a request, detects errors, creates a structured error object, and sends it back so clients get clear, consistent error details.

Execution Sample

NestJS

throw new HttpException({
  status: HttpStatus.BAD_REQUEST,
  error: 'Invalid input',
  code: 'INVALID_INPUT',
}, HttpStatus.BAD_REQUEST);

This code throws a structured error with status, message, and code for the client.

Execution Table

Step	Action	Error Detected?	Error Object Created	Response Sent
1	API receives request	No	No	No
2	Process request logic	Yes (invalid input)	No	No
3	Create structured error object	Yes	Yes ({status: 400, error: 'Invalid input', code: 'INVALID_INPUT'})	No
4	Send structured error response	Yes	Yes	Yes (JSON error response)
5	Client receives error	Yes	Yes	Yes

💡 Structured error sent to client, improving clarity and consistency

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4
errorDetected	false	true	true	true
errorObject	null	null	{status: 400, error: 'Invalid input', code: 'INVALID_INPUT'}	{status: 400, error: 'Invalid input', code: 'INVALID_INPUT'}
responseSent	false	false	false	true

Key Moments - 2 Insights

Why do we create a structured error object instead of just sending a string message?

Structured errors provide consistent fields like status and code, making it easier for clients to handle errors programmatically, as shown in step 3 of the execution_table.

What happens if we don't send a structured error response?

Clients may get unclear or inconsistent error info, making debugging harder. Step 4 shows sending a structured response improves clarity.

Visual Quiz - 3 Questions

Look at the execution_table at step 3, what does the errorObject contain?

A {status:400, error:'Invalid input', code:'INVALID_INPUT'}

B null

C A plain string message

D An empty object

💡 Hint

Check the 'Error Object Created' column at step 3 in the execution_table

At which step is the structured error response sent to the client?

A Step 2

B Step 3

C Step 4

D Step 1

💡 Hint

Look at the 'Response Sent' column in the execution_table

If errorDetected stayed false, what would happen?

A The API would send a structured error

B The API would send a success response

C The API would crash

D The client would receive no response

💡 Hint

Refer to the 'Error Detected?' column and the flow in concept_flow

Concept Snapshot

Throw structured errors in NestJS with status, message, and code.
This improves API clarity and client error handling.
Use HttpException with an object for consistent error responses.
Clients get clear info to react properly.
Avoid sending plain strings or inconsistent errors.

Full Transcript

When an API request is processed, if an error occurs, NestJS allows throwing a structured error object using HttpException. This object includes fields like status code, error message, and a custom code. The API sends this structured error back to the client. This approach helps clients understand exactly what went wrong and handle errors consistently. Without structured errors, clients might get unclear messages, making debugging and user feedback harder. The execution steps show the API receiving a request, detecting an error, creating a structured error object, sending it, and the client receiving clear error details.

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