Java DTO·POJO·record 소스를 넣으면 Spring Boot의 기본 Jackson 설정으로 직렬화했을 때 나올 법한 JSON 예시를 만들어 줍니다. 필드 선언을 기준으로 키를 만들고, @JsonProperty·@JsonIgnore·@JsonIgnoreProperties와 static·transient 같은 제외 규칙을 반영합니다.
컨트롤러의 요청·응답 DTO로 Swagger 예시나 프런트엔드에 넘길 샘플 JSON을 만들 때, 또는 Lombok @Data로 감싼 클래스가 실제로 어떤 키를 내보내는지 빠르게 확인하고 싶을 때 쓰면 됩니다.
import, Lombok 어노테이션, 생성자와 메서드가 있어도 됩니다.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
}
]
}클래스에 붙은 @JsonIgnoreProperties({"password"}) 때문에 password가 빠지고, static final인 serialVersionUID도 나오지 않습니다. grade는 초기값 Grade.SILVER를 읽어 enum의 첫 상수가 아닌 "SILVER"가 됩니다. 중첩 record Address는 객체 배열로 펼쳐집니다.
@JsonProperty("x")와 @JsonProperty(value = "x")로 바꾼 이름을 따릅니다.@JsonIgnore 필드, 클래스의 @JsonIgnoreProperties({...})에 적힌 키, static·transient 필드.record의 구성 요소, 중첩 static class, extends로 상속한 부모 클래스의 필드(부모 필드가 먼저)를 지원합니다.@JsonProperty("x")가 붙어 있으면 x로 나옵니다.LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant·OffsetDateTime·ZonedDateTime → Z로 끝나는 ISO 문자열, java.util.Date·Timestamp → 1970-01-01T00:00:00.000+00:00.BigDecimal·Long 등 숫자 래퍼는 0, Optional<T>는 안쪽 T 값, byte[]는 Base64 문자열, UUID·MongoDB ObjectId는 형식에 맞는 값으로 채웁니다.List·Set·배열은 예시 원소 하나, Map<Long, V>처럼 키가 숫자면 "0", 그 외에는 "key"를 키로 씁니다.응답 DTO마다 example을 손으로 쓰면 필드가 추가될 때마다 문서가 어긋납니다. DTO를 붙여넣어 나온 JSON을 기준으로 값을 다듬으면 키 누락이나 오타 없이 문서를 갱신할 수 있습니다.
@RequestBody로 받는 DTO에서 바로 요청 JSON을 만들어 테스트 코드의 텍스트 블록(""")에 붙여넣습니다. @JsonProperty로 바꾼 키가 반영되므로 실제 바인딩과 같은 이름으로 테스트할 수 있습니다.
백엔드 코드를 볼 수 없는 프런트엔드 개발자에게 엔드포인트가 돌려줄 JSON 구조를 전달할 때, 클래스 소스 대신 결과 JSON을 공유하면 해석할 필요가 없습니다.
= "guest", = 100, = true)이거나 enum 상수(= Grade.SILVER)면 그 값을 쓰고, new ArrayList<>()나 메서드 호출 같은 그 밖의 초기값은 타입의 기본 예시 값으로 둡니다.getFullName(), boolean isVip())는 Jackson처럼 속성으로 추가하고, 그 getter에 붙은 @JsonIgnore·@JsonProperty도 따릅니다. 반대로 getter가 없는 private 필드도 있는 것으로 간주합니다(Lombok @Getter/@Data 사용을 전제).@JsonNaming(SnakeCaseStrategy.class)나 spring.jackson.property-naming-strategy 같은 전역 이름 규칙, @JsonFormat의 날짜 패턴은 적용하지 않습니다.@JsonValue 메서드는 실행하지 않으므로, 그런 enum은 상수 이름(또는 상수의 @JsonProperty 이름)으로 나옵니다.Page<T>·Slice<T> 타입 필드는 원소 배열로 단순화합니다. 실제 Page 직렬화는 content, pageable 등을 가진 객체입니다.@Data, @Getter만 있고 getter가 코드에 없어도 되나요?됩니다. 이 도구는 선언된 필드를 기준으로 키를 만들기 때문에 Lombok이 생성할 getter·setter가 소스에 없어도 결과는 같습니다.
LocalDateTime이 숫자 배열이 아니라 문자열로 나오는 이유는?Spring Boot는 jackson-datatype-jsr310을 등록하고 WRITE_DATES_AS_TIMESTAMPS를 끈 상태가 기본이라 ISO 문자열로 직렬화합니다. 예시도 그 기본값을 따릅니다. 순수 Jackson ObjectMapper라면 설정에 따라 [1970,1,1,0,0] 같은 배열이 나올 수 있습니다.
엔티티 클래스도 필드 구조는 같으므로 그대로 읽습니다. 다만 @OneToMany 같은 연관 관계는 양방향이면 순환이 생기므로 한 번 펼친 뒤 null이나 빈 배열로 끊습니다. JPA 전용 페이지(Spring Boot JPA → JSON)도 따로 있습니다.
@JsonIgnore를 setter나 기존 필드의 getter에 붙였다면요?필드 선언에 붙은 어노테이션은 항상 읽고, getter에 붙은 것은 같은 이름의 필드가 없을 때만 반영합니다. setter나 선언된 필드의 getter에 붙인 @JsonIgnore는 반영되지 않으니 필드로 옮겨서 확인하세요.