Spring Boot - API Documentation
You want to document a complex API model field that can be null but has a maximum length of 50 characters. Which
@Schema annotation usage is correct?You want to document a complex API model field that can be null but has a maximum length of 50 characters. Which @Schema annotation usage is correct?
hard📝 Application Q15 of 15
Step-by-Step Solution
Solution:
Step 1: Understand attribute types for @Schema
Attributes likemaxLengthexpect an integer, andnullableexpects a boolean.Step 2: Match requirements with options
The field can be null, sonullable = trueis needed, and maxLength should be 50 as an integer.Step 3: Eliminate incorrect options
@Schema(description = "Optional comment", maxLength = "50", nullable = "true") private String comment; uses strings for boolean and integer, which is wrong. @Schema(description = "Optional comment", maxLength = 50, required = true) private String comment; marks it required (not nullable). @Schema(description = "Optional comment", maxLength = 50, nullable = false) private String comment; sets nullable false, disallowing null.Final Answer:
@Schema(description = "Optional comment", maxLength = 50, nullable = true) private String comment; -> Option DQuick Check:
Use correct types and nullable=true for optional fields = A [OK]
Quick Trick: Use boolean and int types correctly in @Schema attributes [OK]
Common Mistakes:
- Using strings instead of boolean or int for attributes
- Confusing nullable and required attributes
- Setting nullable false when field can be null
Master "API Documentation" in Spring Boot
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Spring Boot Quizzes