Подайте исходный код Java DTO, POJO или record — и получите JSON, который, скорее всего, выдал бы Jackson в стандартной конфигурации Spring Boot. Ключи берутся из объявленных полей с учётом @JsonProperty, @JsonIgnore, @JsonIgnoreProperties и исключения полей static/transient.
Используйте, чтобы получить пример для Swagger или образец payload для фронтенда по DTO запроса или ответа контроллера, либо просто проверить, какие ключи выдаст класс с Lombok @Data.
static class, record и enum в тот же ввод, чтобы ссылающиеся на них поля заполнились их структурой.Корневой тип установлен в Автоматически, выбирается класс, который ни один другой класс не использует как тип поля. Если сущности ссылаются друг на друга, выберите нужную из списка.@Schema(example = ...), сниппет REST Docs или тело запроса MockMvc.@Data
@JsonIgnoreProperties({"password"})
public class MemberResponse {
private Long memberId;
@JsonProperty("nick_name")
private String nickname;
private String password;
private Grade grade = Grade.SILVER;
private LocalDate birthDate;
private List<Address> addresses;
private static final long serialVersionUID = 1L;
public enum Grade { BRONZE, SILVER, GOLD }
public record Address(String zipCode, String city, boolean primary) {}
}{
"memberId": 0,
"nick_name": "",
"grade": "SILVER",
"birthDate": "1970-01-01",
"addresses": [
{
"zipCode": "",
"city": "",
"primary": false
}
]
}password убран аннотацией уровня класса @JsonIgnoreProperties({"password"}), а static final serialVersionUID вообще не появляется. Инициализатор Grade.SILVER считывается, так что grade равен "SILVER", а не первой константе enum. Вложенный record Address разворачивается в массив объектов.
@JsonProperty("x") или @JsonProperty(value = "x").@JsonIgnore, ключи, перечисленные в @JsonIgnoreProperties({...}) на уровне класса, а также поля static и transient.record из Java 16+, вложенные объявления static class и поля, унаследованные через extends (сначала поля родителя).@JsonProperty("x") на константе меняет строку на x.LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant/OffsetDateTime/ZonedDateTime → ISO-строка с Z на конце, java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00.BigDecimal и Long становятся 0, Optional<T> разворачивается в T, byte[] становится строкой Base64, а UUID и ObjectId из MongoDB получают корректно сформированные значения.List, Set и массивы получают один элемент-пример; map с числовым ключом вроде Map<Long, V> использует "0", иначе — "key".Написанные вручную значения example расходятся с кодом при каждом добавлении поля в DTO. Сгенерируйте JSON из исходника DTO и доведите значения уже от него — тогда ни один ключ не пропадёт и не будет написан с ошибкой.
Создайте JSON запроса прямо из DTO с @RequestBody и вставьте его в текстовый блок (""") в тесте. Ключи, переименованные через @JsonProperty, уже применены — как при реальной привязке.
Фронтенд-разработчики, которые не читают код бэкенда, получают структуру JSON эндпоинта напрямую, без необходимости разбираться в Java-классе.
= "guest", = 100, = true) или константа enum (= Grade.SILVER); всё остальное, например new ArrayList<>() или вызов метода, заменяется значением-заглушкой для типа.getFullName() или boolean isVip(), добавляются как свойства, как это делает Jackson, с учётом @JsonIgnore/@JsonProperty на этом геттере. И наоборот, private-поле без геттера считается видимым (как с Lombok @Getter/@Data).@JsonNaming(SnakeCaseStrategy.class), spring.jackson.property-naming-strategy) и шаблоны дат @JsonFormat не применяются.@JsonValue в enum не вычисляются, поэтому такие enum всё равно показывают константу (или её имя из @JsonProperty).Page<T>/Slice<T> упрощаются до массива элементов; реальная сериализация Page — это объект с content, pageable и прочим.@Data или @Getter?Да. Ключи строятся по объявленным полям, так что геттеры и сеттеры, которые Lombok генерирует при компиляции, в исходнике не нужны.
LocalDateTime — строка, а не массив чисел?Spring Boot регистрирует jackson-datatype-jsr310 и по умолчанию отключает WRITE_DATES_AS_TIMESTAMPS, что даёт ISO-строки; пример следует этому умолчанию. «Голый» ObjectMapper из Jackson может вместо этого записать массив вроде [1970,1,1,0,0].
У сущностей та же структура полей, так что они разбираются нормально. Двунаправленные связи вроде @OneToMany зациклились бы, поэтому они разворачиваются один раз и обрываются на null или пустом массиве. Есть и отдельная страница Spring Boot JPA → JSON.
@JsonIgnore стоит на сеттере или на геттере существующего поля?Аннотации на объявлении поля применяются всегда, а аннотации на геттере — только если поля с таким именем нет. @JsonIgnore на сеттере или на геттере объявленного поля не применяется, так что перенесите её на поле, чтобы увидеть эффект.