Spring Boot - API Documentation
Which annotation is commonly used to add metadata for Swagger UI documentation in Spring Boot?
Which annotation is commonly used to add metadata for Swagger UI documentation in Spring Boot?
easy📝 Conceptual Q2 of 15
Step-by-Step Solution
Solution:
Step 1: Identify Swagger metadata annotation
@OpenAPIDefinition is used to provide global API metadata for Swagger UI.Step 2: Eliminate unrelated annotations
@RestController, @Entity, and @Service serve other Spring roles, not Swagger metadata.Final Answer:
@OpenAPIDefinition -> Option AQuick Check:
Swagger metadata annotation = @OpenAPIDefinition [OK]
Quick Trick: Use @OpenAPIDefinition for Swagger metadata [OK]
Common Mistakes:
- Using @RestController for Swagger metadata
- Confusing @Entity with API docs
- Assuming @Service adds Swagger info
Master "API Documentation" in Spring Boot
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Spring Boot Quizzes