13. Advanced REST Controllers, DTOs & Production Architecture

REST Controllers, ResponseEntity & Jackson

Master REST controllers, ResponseEntity HTTP status codes, Jackson JSON serialization pipeline, Optional missing-record handling, and 11-step bidirectional request flows.

REST Controllers, ResponseEntity & Jackson

The Controller Layer serves as the protocol boundary translating raw HTTP bytes into typed Java method calls and serializing domain results back into JSON HTTP responses.

1. Controller Protocol Boundary

@RestController
@RequestMapping("/api/students")
public class StudentController {

    private final StudentService service;

    // Constructor Injection
    public StudentController(StudentService service) {
        this.service = service;
    }
}
  • @RestController: Composite annotation combining @Controller and @ResponseBody, instructing Spring MVC to serialize return values directly into the HTTP response body.
  • @RequestMapping("/api/students"): Defines the common base URI route for all endpoints within the controller class.

2. Explicit HTTP Control via ResponseEntity<T>

An HTTP response consists of three core elements:

  1. HTTP Status Code (e.g. 200 OK, 201 Created, 404 Not Found)
  2. HTTP Headers (e.g. Content-Type: application/json)
  3. HTTP Response Body (e.g. JSON bytes)

ResponseEntity<T> provides explicit programmatic control over all three elements:

// Returning 201 Created with created object
return ResponseEntity.status(HttpStatus.CREATED).body(createdStudent);

// Returning 200 OK with body
return ResponseEntity.ok(activeStudents);

// Returning 404 Not Found without body
return ResponseEntity.notFound().build();

// Returning 204 No Content for successful deletion
return ResponseEntity.noContent().build();

Standard CRUD HTTP Status Codes

CRUD OperationSuccess Status CodeFailure Status Code
POST (Create)201 Created400 Bad Request / 409 Conflict
GET (Read Single)200 OK404 Not Found
GET (Read List)200 OK (Empty list [] if none)500 Internal Server Error
PUT (Update)200 OK404 Not Found / 400 Bad Request
DELETE (Delete)204 No Content404 Not Found

3. Jackson Serialization & Deserialization Pipeline

Spring Web uses the Jackson library (ObjectMapper) to marshal data between JSON text strings and Java domain objects:

HTTP Request Body (JSON) ──► Jackson Deserialization ──► Java Student Object
                                                              │
                                                        Service/JPA Processing
                                                              │
HTTP Response Body (JSON) ◄── Jackson Serialization ◄─── Java Student Object

4. Handling Optional<T> Cleanly

repository.findById(id) returns an Optional<Student>. Handling this cleanly in the Controller avoids throwing unhandled NoSuchElementException exceptions:

@GetMapping("/{id}")
public ResponseEntity<Student> getStudentById(@PathVariable Long id) {
    return service.getStudentById(id)
            .map(ResponseEntity::ok)                           // Returns 200 OK if present
            .orElseGet(() -> ResponseEntity.notFound().build()); // Returns 404 Not Found if absent
}

5. Complete 11-Step Bidirectional Execution Pipeline

1. POST /api/students (JSON Body) 2. Match Route & Deserialize JSON 3. Invoke createStudent(Student) 4. Invoke repository.save(Student) 5. Delegate persistence task 6. Execute SQL INSERT INTO students... 7. Confirm Insert & Return Primary Key ID (e.g. 42) 8. Update Entity with ID = 42 9. Return Managed Entity 10. Return Entity to Controller 11. Return 201 Created (JSON Response Body) Postman / Client DispatcherServlet StudentController StudentService StudentRepository Hibernate ORM MySQL Database

❓ Knowledge Check

Knowledge Check

What is the purpose of ResponseEntity in Spring Boot REST controllers?

Knowledge Check

How does Jackson participate in Spring Web execution?

Entity Design, Repository Proxies & Persistence Context

Master JPA entity design, Spring Data interface proxies, derived queries, persistence context dirty checking, and B-Tree query complexity.

DTOs, State Machines, Anti-Patterns & Debugging

Master DTO decoupling, CRUD state machine transitions, race condition avoidance, production anti-patterns, and outside-in debugging checklists.

On this page

REST Controllers, ResponseEntity & Jackson1. Controller Protocol Boundary2. Explicit HTTP Control via ResponseEntity<T>Standard CRUD HTTP Status Codes3. Jackson Serialization & Deserialization Pipeline4. Handling Optional<T> Cleanly5. Complete 11-Step Bidirectional Execution Pipeline❓ Knowledge Check