Bird
0
0

Why might the @Operation annotation's description not appear in Swagger UI even if correctly set?

medium📝 Debug Q7 of 15
Spring Boot - API Documentation
Why might the @Operation annotation's description not appear in Swagger UI even if correctly set?
AThe controller method is private
BSwagger UI version does not support description display
CMissing @RestController annotation
DDescription attribute is misspelled
Step-by-Step Solution
Solution:

  1. Step 1: Consider Swagger UI capabilities

    Older Swagger UI versions may not display the description attribute properly.

  2. Step 2: Check other possible causes

    Private methods are not exposed, but if method is public and annotation correct, UI version is likely cause.

  3. Final Answer:

    Swagger UI version does not support description display -> Option B

  4. Quick Check:

    Swagger UI version affects description display [OK]
Quick Trick: Update Swagger UI to latest for full description support [OK]
Common Mistakes:
  • Assuming private methods show in docs
  • Missing controller annotations
  • Misspelling description attribute

Want More Practice?

15+ quiz questions · All difficulty levels · Free

Free Signup - Practice All Questions
More Spring Boot Quizzes
API Documentation - Grouping APIs by tags - Quiz 12easy API Documentation - Swagger UI integration - Quiz 3easy Aspect-Oriented Programming - @Aspect annotation - Quiz 1easy Caching - @CachePut for updating cache - Quiz 7medium Docker and Deployment - docker-compose for services - Quiz 9hard Docker and Deployment - CI/CD pipeline basics - Quiz 14medium Docker and Deployment - Why containerization matters - Quiz 3easy Docker and Deployment - Health checks in Docker - Quiz 3easy Messaging - @RabbitListener for consuming - Quiz 11easy Spring Boot Actuator - Info endpoint configuration - Quiz 2easy