[Solved] In this code snippet:@Schema(description = "User's email", example = "user@example.... What is the most probable reason? | Spring Boot

Spring Boot - API Documentation

In this code snippet:

@Schema(description = "User's email", example = "user@example.com")
private String email;

The example value does not appear in the generated API docs. What is the most probable reason?

AThe OpenAPI generator version does not support the example attribute

BThe field is private and needs a public getter to be documented

CThe example attribute requires a string literal, but the value is missing quotes

DThe @Schema annotation must be placed on the getter method, not the field

Step-by-Step Solution

Solution:

Step 1: Understand how OpenAPI reads model properties
OpenAPI generators often require public getters to detect and document private fields.
Step 2: Check other options
The example value is correctly quoted. Most recent OpenAPI versions support example. @Schema can be on field or getter, but missing getter often causes missing docs.
Final Answer:
The field is private and needs a public getter to be documented -> Option B
Quick Check:
Private fields need public getters for docs [OK]

Quick Trick: Add public getters to private fields for documentation [OK]

Common Mistakes:

Master "API Documentation" in Spring Boot

9 interactive learning modes - each teaches the same concept differently

More Spring Boot Quizzes

In this code snippet: