@Operation annotation for descriptions in Spring Boot - Step-by-Step Execution

Concept Flow - @Operation annotation for descriptions

Write REST Controller Method

↓

Add @Operation Annotation

↓

Set description attribute

↓

Springdoc Reads Annotation

↓

Generate API Documentation with Description

↓

User Views API Docs with Descriptions

This flow shows how adding @Operation with a description to a REST method helps Springdoc generate clear API docs.

Execution Sample

Spring Boot

@RestController
public class MyController {
  @Operation(description = "Get all users")
  @GetMapping("/users")
  public List<User> getUsers() { return List.of(); }
}

A REST method annotated with @Operation to add a description for API documentation.

Execution Table

Step	Action	Annotation Read	Effect
1	Spring Boot starts and scans controllers	No @Operation yet	No description in docs
2	Reads MyController class	Finds @Operation on getUsers()	Captures description 'Get all users'
3	Springdoc builds API docs	Uses description from @Operation	API docs show 'Get all users' for GET /users
4	User opens API docs UI	Description visible	User understands endpoint purpose

💡 API docs generated with descriptions from @Operation annotations

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
description	null	"Get all users"	"Get all users"	"Get all users"

Key Moments - 2 Insights

Why doesn't the description appear if @Operation is missing?

Without @Operation, Springdoc has no description to read, so the docs show no description (see execution_table step 1).

Can @Operation description be changed dynamically?

No, @Operation is a static annotation read at startup (see execution_table step 2), so descriptions are fixed until restart.

Visual Quiz - 3 Questions

Look at the execution table, at which step does Springdoc capture the description?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Check the 'Annotation Read' column in execution_table rows

According to variable_tracker, what is the value of 'description' after step 3?

A "Get all users"

B "No description"

C null

D undefined

💡 Hint

Look at the 'description' row under 'After Step 3' in variable_tracker

If @Operation annotation is removed, what happens to the API docs description?

A API docs fail to generate

B Description remains the same

C Description becomes empty

D Description shows default text

💡 Hint

Refer to key_moments about missing @Operation and execution_table step 1

Concept Snapshot

@Operation annotation adds descriptions to REST methods.
Place it above controller methods.
Springdoc reads it at startup.
Descriptions appear in generated API docs.
No annotation means no description shown.

Full Transcript

This visual trace shows how the @Operation annotation in Spring Boot REST controllers adds descriptions for API documentation. First, the REST method is written, then @Operation with a description is added. When Spring Boot starts, it scans the controller and reads the @Operation annotation. Springdoc captures the description and uses it to generate API docs. When users open the docs, they see the description explaining the endpoint. Variables like 'description' start as null and get set when the annotation is read. If @Operation is missing, no description appears. This helps beginners understand how adding @Operation improves API docs clarity.

Practice

1. What is the main purpose of the @Operation annotation in Spring Boot APIs?

easy

A. To add descriptions and summaries to API endpoints for documentation

B. To handle database transactions automatically

C. To secure API endpoints with authentication

D. To configure server port settings

Solution

1. Step 1: Understand the role of @Operation

   The @Operation annotation is used to add descriptive metadata to API endpoints.

2. Step 2: Identify its main use

   It helps generate clear API documentation by providing summaries and detailed descriptions.

3. Final Answer:

   To add descriptions and summaries to API endpoints for documentation -> Option A

4. Quick Check:

   @Operation adds descriptions [OK]

Hint: Remember: @Operation documents APIs, not config or security [OK]

Common Mistakes:

• Confusing @Operation with security annotations
• Thinking it manages database or server settings
• Using it to handle authentication

2. Which of the following is the correct way to add a short summary and a detailed description using @Operation?

easy

A. @Operation(title = "Short info", details = "Detailed info")

B. @Operation(summary = "Short info", description = "Detailed info")

C. @Operation(info = "Short info", text = "Detailed info")

D. @Operation(header = "Short info", body = "Detailed info")

Solution

1. Step 1: Recall the correct attribute names

   The @Operation annotation uses summary for short info and description for detailed info.

2. Step 2: Match attributes to options

   Only @Operation(summary = "Short info", description = "Detailed info") uses summary and description correctly.

3. Final Answer:

   @Operation(summary = "Short info", description = "Detailed info") -> Option B

4. Quick Check:

   Use summary and description in @Operation [OK]

Hint: Use summary and description exactly [OK]

Common Mistakes:

• Using wrong attribute names like title or info
• Mixing up summary and description
• Omitting either summary or description

3. Given the code snippet:

@Operation(summary = "Get user", description = "Returns user details by ID")
@GetMapping("/user/{id}")
public User getUser(@PathVariable String id) { return userService.findById(id); }

What will the @Operation annotation affect?

medium

A. It will generate API documentation showing the summary and description for this endpoint

B. It will change the URL path to "/user/getUser" automatically

C. It will validate the user ID parameter before method execution

D. It will encrypt the response data automatically

Solution

1. Step 1: Understand @Operation effect on API docs

   The annotation adds metadata used by tools like Swagger to generate documentation.

2. Step 2: Check other options for correctness

   It does not change URL paths, validate parameters, or encrypt data.

3. Final Answer:

   It will generate API documentation showing the summary and description for this endpoint -> Option A

4. Quick Check:

   @Operation affects docs only [OK]

Hint: Remember: @Operation only documents, does not change behavior [OK]

Common Mistakes:

• Thinking it modifies URL or method behavior
• Assuming it validates inputs
• Believing it encrypts data

4. Identify the error in this usage of @Operation:

@Operation(summary = "Create item", description = 12345)
@PostMapping("/item")
public Item createItem(@RequestBody Item item) { return itemService.save(item); }

medium

A. The @PostMapping annotation is incorrect

B. The summary attribute is missing

C. The method return type should be void

D. The description value must be a string, not a number

Solution

1. Step 1: Check attribute types in @Operation

   The description attribute must be a string, but 12345 is a number.

2. Step 2: Verify other parts

   The summary is present, @PostMapping is correct, and return type can be Item.

3. Final Answer:

   The description value must be a string, not a number -> Option D

4. Quick Check:

   @Operation attributes require string values [OK]

Hint: Always use quotes for @Operation text values [OK]

Common Mistakes:

• Passing non-string values to summary or description
• Confusing HTTP method annotations
• Expecting void return type for create methods

5. You want to document an API endpoint that returns a list of products with a short summary and a detailed description including usage notes. Which @Operation annotation usage is best?

hard

A. @Operation(description = "Returns all products.")

B. @Operation(summary = "List products")

C. @Operation(summary = "List products", description = "Returns all products. Use filters to narrow results.")

D. @Operation(notes = "Returns all products with filters.")

Solution

1. Step 1: Identify required documentation details

   You need both a short summary and a detailed description with usage notes.

2. Step 2: Match attributes to requirements

   @Operation(summary = "List products", description = "Returns all products. Use filters to narrow results.") uses both summary and description properly to provide clear info.

3. Step 3: Check other options

   Options B and C provide only one attribute; D uses an invalid attribute notes.

4. Final Answer:

   @Operation(summary = "List products", description = "Returns all products. Use filters to narrow results.") -> Option C

5. Quick Check:

   Use both summary and description for full docs [OK]

Hint: Use both summary and description for complete API docs [OK]

Common Mistakes:

• Using only summary or description alone
• Using unsupported attributes like notes
• Leaving out usage details in description