Response DTO for output in Spring Boot - Step-by-Step Execution

Concept Flow - Response DTO for output

Client sends request

↓

Controller receives request

↓

Controller calls Service

↓

Service prepares Response DTO

↓

Controller returns Response DTO

↓

Client receives JSON output

Shows how a Spring Boot controller uses a Response DTO to send structured output back to the client.

Execution Sample

Spring Boot

public record UserResponseDTO(Long id, String name, String email) {}

@GetMapping("/user/{id}")
public UserResponseDTO getUser(@PathVariable Long id) {
    User user = userService.findById(id);
    return new UserResponseDTO(user.getId(), user.getName(), user.getEmail());
}

A Spring Boot controller method returns a UserResponseDTO as JSON output for a user request.

Execution Table

Step	Action	Input/State	Output/Result
1	Client sends GET /user/5	Request: /user/5	Request received by Controller
2	Controller calls userService.findById(5)	id=5	User object with id=5, name='Alice', email='[e-mail]'
3	Controller creates UserResponseDTO	User data	UserResponseDTO(id=5, name='Alice', email='[e-mail]')
4	Controller returns UserResponseDTO	UserResponseDTO	JSON response sent to client
5	Client receives JSON	JSON: {"id":5,"name":"Alice","email":"[e-mail]"}	Client displays or processes data
6	End	No more actions	Response cycle complete

💡 Response DTO sent as JSON and client receives it, ending the request-response cycle.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
id	null	5	5	5
user	null	User(id=5, name='Alice', email='[e-mail]')	User(id=5, name='Alice', email='[e-mail]')	User(id=5, name='Alice', email='[e-mail]')
responseDTO	null	null	UserResponseDTO(id=5, name='Alice', email='[e-mail]')	UserResponseDTO(id=5, name='Alice', email='[e-mail]')

Key Moments - 2 Insights

Why do we use a Response DTO instead of returning the User entity directly?

The Response DTO controls exactly what data is sent to the client, avoiding exposing sensitive or unnecessary fields. See step 3 in execution_table where only selected fields are included.

What happens if the userService.findById returns null?

If null is returned, the controller should handle it (e.g., return 404). This example assumes a valid user is found as shown in step 2.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'responseDTO' after step 3?

A null

B User entity

C UserResponseDTO with user data

D JSON string

💡 Hint

Check the variable_tracker row for 'responseDTO' after step 3.

At which step does the controller send the JSON response to the client?

A Step 4

B Step 3

C Step 2

D Step 5

💡 Hint

Look at the 'Output/Result' column in execution_table for when JSON is sent.

If the userService returned a user with an extra field 'password', would it appear in the JSON response?

A Yes, all user fields are included

B No, only fields in Response DTO are included

C Only if annotated with @JsonInclude

D Only if controller manually adds it

💡 Hint

Response DTO defines exactly which fields are sent, see step 3 and variable_tracker.

Concept Snapshot

Response DTO in Spring Boot:
- A simple class or record holding output data
- Controller returns DTO, not entity
- Spring converts DTO to JSON automatically
- Controls data sent to client
- Helps keep API clean and secure

Full Transcript

This visual execution shows how a Spring Boot controller handles a client request by returning a Response DTO. The client sends a GET request for a user. The controller calls a service to get the user entity. Then it creates a Response DTO with selected user fields. The controller returns this DTO, which Spring converts to JSON and sends to the client. The client receives the JSON and can use it. Variables like 'id', 'user', and 'responseDTO' change as the code runs. Key points include why to use a DTO and what happens if no user is found. The quizzes check understanding of variable states and response timing.