[Solved] Consider this annotation usage:@Operation(summary = "Get products", description = Get all products)Why might the description not appear in the generated API docs? | Spring Boot

Spring Boot - API Documentation

Consider this annotation usage:

@Operation(summary = "Get products", description = Get all products)

Why might the description not appear in the generated API docs?

AThe summary attribute must be omitted to show the description.

BThe description value is not enclosed in quotes, causing a syntax error.

CThe description attribute is deprecated and ignored.

DThe annotation requires an additional @ApiResponse annotation to show descriptions.

Step-by-Step Solution

Solution:

Step 1: Analyze the description value
The description value must be a string literal enclosed in quotes.
Step 2: Identify the error
Here, Get all products is not quoted, so it is treated as an identifier, causing the description to be ignored.
Final Answer:
The description value is not enclosed in quotes, causing a syntax error. -> Option B
Quick Check:
Always quote string values in annotations [OK]

Quick Trick: Always quote string literals in annotation attributes [OK]

Common Mistakes:

Master "API Documentation" in Spring Boot

9 interactive learning modes - each teaches the same concept differently

More Spring Boot Quizzes

Consider this annotation usage: