[Solved] You have this method parameter:@Parameter(description = "User ID", required = true) String userIdBut the generated API docs do not show the description. What is a likely cause? | Spring Boot

Spring Boot - API Documentation

You have this method parameter:

@Parameter(description = "User ID", required = true) String userId

But the generated API docs do not show the description. What is a likely cause?

AThe @Parameter annotation is missing the <code>@Operation</code> annotation on the method

BThe project lacks the OpenAPI dependency to process @Parameter annotations

CThe parameter type must be primitive for @Parameter to work

DThe description attribute is misspelled

Step-by-Step Solution

Solution:

Step 1: Check project setup for OpenAPI support
@Parameter annotations require OpenAPI or Swagger dependencies to generate documentation properly.
Step 2: Verify other options
@Operation is not mandatory for @Parameter to work. Parameter type can be String. Description attribute is correct.
Final Answer:
The project lacks the OpenAPI dependency to process @Parameter annotations -> Option B
Quick Check:
Missing OpenAPI dependency = No @Parameter docs [OK]

Quick Trick: Add OpenAPI dependency to enable @Parameter docs [OK]

Common Mistakes:

Master "API Documentation" in Spring Boot

9 interactive learning modes - each teaches the same concept differently

More Spring Boot Quizzes

You have this method parameter: