@Operation annotation for descriptions in Spring Boot - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add a description to the API operation using @Operation.

Spring Boot

@Operation(description = "[1]")
public ResponseEntity<String> getHello() {
    return ResponseEntity.ok("Hello World");
}

Drag options to blanks, or click blank then click option'

AHello World

BReturns a greeting message

CAPI endpoint

DGet method

Attempts:

3 left

💡 Hint

Common Mistakes

Putting the actual return value as description

Leaving description empty

Using unrelated text

The @Operation annotation's description attribute should describe what the API operation does, such as 'Returns a greeting message'.

2fill in blank

medium

Complete the code to import the correct package for @Operation annotation.

Spring Boot

import [1];

@Operation(description = "Fetch user details")
public User getUser() {
    return new User();
}

Drag options to blanks, or click blank then click option'

Aio.swagger.v3.oas.annotations.Operation

Borg.springframework.web.bind.annotation.Operation

Cjavax.ws.rs.Operation

Dorg.springframework.boot.Operation

Attempts:

3 left

💡 Hint

Common Mistakes

Using Spring or Java EE packages instead of Swagger's

Misspelling the package name

Omitting the import

The @Operation annotation is from the package io.swagger.v3.oas.annotations.Operation used for OpenAPI documentation.

3fill in blank

hard

Fix the error in the @Operation annotation to correctly add a summary.

Spring Boot

@Operation([1] = "Get all products")
public List<Product> getProducts() {
    return productService.findAll();
}

Drag options to blanks, or click blank then click option'

Avalue

Btitle

Csummary

Ddescription

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'description' instead of 'summary' for short text

Using unsupported attribute names

Syntax errors in annotation

The correct attribute to add a short summary in @Operation is 'summary', not 'description' or others.

4fill in blank

hard

Fill both blanks to add a description and a summary to the @Operation annotation.

Spring Boot

@Operation(summary = "[1]", description = "[2]")
public ResponseEntity<Void> deleteUser(Long id) {
    userService.delete(id);
    return ResponseEntity.noContent().build();
}

Drag options to blanks, or click blank then click option'

ADelete a user

BRemoves a user by ID

CFetch user info

DCreates a new user

Attempts:

3 left

💡 Hint

Common Mistakes

Swapping summary and description texts

Using unrelated texts

Leaving blanks empty

The summary is a short phrase like 'Delete a user', and the description is a longer explanation like 'Removes a user by ID'.

5fill in blank

hard

Fill all three blanks to add summary, description, and tags to the @Operation annotation.

Spring Boot

@Operation(summary = "[1]", description = "[2]", tags = {"[3]"})
@GetMapping("/orders")
public List<Order> listOrders() {
    return orderService.getAll();
}

Drag options to blanks, or click blank then click option'

AList orders

BReturns all orders in the system

Corders

Dusers

Attempts:

3 left

💡 Hint

Common Mistakes

Using unrelated tags

Leaving tags empty

Mixing summary and description

Summary is a short phrase, description explains the operation, and tags categorize the API endpoint.

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