Given this Spring Boot controller snippet with Springdoc enabled, what will the generated API docs show for the endpoint?

medium📝 component behavior Q13 of 15

Spring Boot - API Documentation

@RestController
@RequestMapping("/api")
public class UserController {
  @GetMapping("/users/{id}")
  public User getUser(@PathVariable String id) {
    return new User(id, "Alice");
  }
}

AAn endpoint POST /api/users that creates a new user.

BAn endpoint GET /users without path variables.

CNo endpoint will be documented because @GetMapping is missing.

DAn endpoint GET /api/users/{id} that returns a User object with id and name.

Step-by-Step Solution

Solution:

Step 1: Analyze the controller mapping
The class maps to /api, and the method maps GET requests to /users/{id} with a path variable.
Step 2: Understand Springdoc output
Springdoc generates docs showing GET /api/users/{id} returning a User object with id and name fields.
Final Answer:
An endpoint GET /api/users/{id} that returns a User object with id and name. -> Option D
Quick Check:
GET /api/users/{id} documented with User return [OK]

Quick Trick: Check @RequestMapping + @GetMapping paths for docs URL [OK]

Common Mistakes:

Confusing GET with POST method
Ignoring path variables in URL
Assuming no docs generated without extra config

Master "API Documentation" in Spring Boot

9 interactive learning modes - each teaches the same concept differently

Learn Why Deep Visual Try Challenge Project Recall Perf

Want More Practice?

15+ quiz questions · All difficulty levels · Free

Free Signup - Practice All Questions

More Spring Boot Quizzes

Given this Spring Boot controller snippet with Springdoc enabled, what will the generated API docs show for the endpoint?

Step 1: Analyze the controller mapping

Step 2: Understand Springdoc output

Final Answer:

Quick Check:

Want More Practice?