Why REST controllers are essential in Spring Boot - Visual Breakdown

Concept Flow - Why REST controllers are essential

Client sends HTTP request

↓

REST Controller receives request

↓

Controller processes request

↓

Calls service/business logic

↓

Service returns data/result

↓

Controller formats response

↓

Sends HTTP response back to client

This flow shows how a REST controller acts as the middleman between the client and the server logic, handling requests and sending responses.

Execution Sample

Spring Boot

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, world!";
    }
}

A simple REST controller that listens for GET requests at /hello and returns a greeting string.

Execution Table

Step	Action	Input	Processing	Output
1	Client sends GET request to /hello	GET /hello	Request received by HelloController	N/A
2	Controller method sayHello() called	N/A	Method executes and returns "Hello, world!"	"Hello, world!" string
3	Controller sends HTTP response	"Hello, world!"	Response formatted as HTTP 200 OK with body	HTTP 200 OK with "Hello, world!" body
4	Client receives response	HTTP 200 OK with body	Client displays or uses response	Displays "Hello, world!"

💡 Request completed and response sent back to client

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
request	null	GET /hello	GET /hello	null (processed)
responseBody	null	null	"Hello, world!"	"Hello, world!"
httpResponse	null	null	HTTP 200 OK with body	Sent to client

Key Moments - 2 Insights

Why does the controller method return a string instead of sending the response directly?

The controller returns data (like a string) which Spring Boot automatically converts into an HTTP response. This separation lets the framework handle formatting and sending the response, as shown in execution_table step 3.

What happens if the client sends a request to a URL not handled by any controller?

The request won't match any controller method, so Spring Boot returns a 404 Not Found error. This is because no controller received or processed the request, unlike the flow shown in step 1.

Visual Quiz - 3 Questions

Look at the execution table, what is the output after the controller method sayHello() executes?

A HTTP 404 Not Found

B "Hello, world!" string

C null

D GET /hello request

💡 Hint

Check the 'Output' column at Step 2 in the execution_table.

At which step does the HTTP response get sent back to the client?

A Step 1

B Step 4

C Step 3

D Step 2

💡 Hint

Look for the step where the controller formats and sends the HTTP response in the execution_table.

If the controller method returned a JSON object instead of a string, how would the output change at Step 2?

A Output would be a JSON string representation

B Output would be HTTP 500 error

C Output would remain a plain string

D Output would be null

💡 Hint

Consider how Spring Boot converts return values to HTTP responses as shown in Step 3.

Concept Snapshot

REST controllers handle HTTP requests and responses.
They receive client requests, call business logic, and return data.
Spring Boot converts returned data into HTTP responses.
Controllers separate request handling from business logic.
They are essential for building web APIs.

Full Transcript

A REST controller in Spring Boot is essential because it acts as the bridge between the client and the server's business logic. When a client sends an HTTP request, the REST controller receives it and calls the appropriate method. This method processes the request and returns data, such as a string or JSON object. Spring Boot then automatically converts this data into an HTTP response and sends it back to the client. This separation allows developers to focus on business logic while the framework manages HTTP details. If a request does not match any controller, the client receives a 404 error. This flow ensures clear, organized handling of web requests and responses.

Practice

1. Why are REST controllers essential in a Spring Boot application?

easy

A. They manage database connections directly.

B. They style the user interface of the application.

C. They handle HTTP requests and return data in formats like JSON.

D. They compile the Java code into bytecode.

Solution

1. Step 1: Understand the role of REST controllers

   REST controllers are designed to handle web requests and responses in a Spring Boot app.

2. Step 2: Identify what REST controllers return

   They typically return data in formats like JSON, which is easy for other apps to use.

3. Final Answer:

   They handle HTTP requests and return data in formats like JSON. -> Option C

4. Quick Check:

   REST controllers = handle HTTP + return JSON [OK]

Hint: REST controllers handle web requests and send JSON responses [OK]

Common Mistakes:

• Thinking REST controllers manage database connections
• Confusing REST controllers with UI styling components
• Believing REST controllers compile code

2. Which annotation is used to define a REST controller in Spring Boot?

easy

A. @RestController

B. @Controller

C. @Service

D. @Repository

Solution

1. Step 1: Recall Spring Boot annotations for controllers

   @Controller is for MVC controllers, but REST controllers need to return data directly.

2. Step 2: Identify the annotation that combines @Controller and @ResponseBody

   @RestController does both, making it perfect for REST APIs.

3. Final Answer:

   @RestController -> Option A

4. Quick Check:

   @RestController = REST API controller [OK]

Hint: Use @RestController to create REST APIs in Spring Boot [OK]

Common Mistakes:

• Using @Controller without @ResponseBody for REST APIs
• Confusing @Service or @Repository as controller annotations
• Omitting the annotation entirely

3. What will be the output when accessing the endpoint defined by this REST controller method?

@RestController
public class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello, World!";
  }
}

medium

A. A JSON object {"message":"Hello, World!"}

B. Plain text response: Hello, World!

C. HTTP 404 Not Found error

D. An HTML page with 'Hello, World!' text

Solution

1. Step 1: Analyze the method return type and annotation

   The method returns a String and is inside a @RestController, so the string is sent as plain text.

2. Step 2: Understand @RestController behavior

   @RestController automatically adds @ResponseBody, so the return is the response body, not a view or JSON object.

3. Final Answer:

   Plain text response: Hello, World! -> Option B

4. Quick Check:

   String return in @RestController = plain text response [OK]

Hint: String return in @RestController sends plain text response [OK]

Common Mistakes:

• Expecting JSON output without wrapping string in an object
• Thinking it returns an HTML page
• Assuming 404 error without mapping

4. Identify the error in this REST controller code snippet:

@RestController
public class UserController {
  @GetMapping("/user")
  public User getUser() {
    User user = new User("Alice", 30);
    return user;
  }
}

Assuming User is a simple POJO with name and age fields.

medium

A. No error; this code will return user data as JSON

B. User class must be annotated with @Entity

C. The method should return String, not User

D. Missing @ResponseBody annotation on the method

Solution

1. Step 1: Check if @RestController handles response body automatically

   @RestController combines @Controller and @ResponseBody, so no need to add @ResponseBody on methods.

2. Step 2: Confirm if returning a POJO works

   Spring Boot automatically converts POJOs to JSON in REST responses.

3. Final Answer:

   No error; this code will return user data as JSON -> Option A

4. Quick Check:

   @RestController + POJO return = JSON response [OK]

Hint: @RestController auto-converts POJOs to JSON, no extra annotation needed [OK]

Common Mistakes:

• Adding unnecessary @ResponseBody on methods inside @RestController
• Thinking POJO must be @Entity for REST response
• Changing return type to String unnecessarily

5. You want to create a REST controller that returns a list of users as JSON. Which approach correctly ensures the response is JSON and accessible at "/users" endpoint?

@RestController
public class UserController {
  public List<User> getUsers() {
    return List.of(new User("Bob", 25), new User("Carol", 28));
  }
}

hard

A. Return a String with JSON manually instead of List<User>

B. Change @RestController to @Controller and add @ResponseBody on getUsers()

C. Annotate User class with @RestController

D. Add @GetMapping("/users") above getUsers() method

Solution

1. Step 1: Identify missing mapping annotation

   The method lacks @GetMapping, so it won't be exposed as an endpoint.

2. Step 2: Confirm correct annotation for REST endpoint

   Adding @GetMapping("/users") exposes the method at /users and returns JSON automatically.

3. Final Answer:

   Add @GetMapping("/users") above getUsers() method -> Option D

4. Quick Check:

   @GetMapping + @RestController = JSON endpoint [OK]

Hint: Use @GetMapping on method inside @RestController for JSON endpoint [OK]

Common Mistakes:

• Forgetting @GetMapping annotation on methods
• Misusing @Controller without @ResponseBody
• Trying to manually build JSON strings
• Annotating POJO class with @RestController