이미 작성해 둔 Kotlin data class를 붙여넣으면 그 클래스가 직렬화될 때의 모양을 예시 JSON으로 보여 줍니다. 중첩된 클래스, List·Map, enum까지 따라가며 값을 채우고, @SerialName 같은 이름 변경 어노테이션도 반영합니다.
서버와 앱이 같은 모델을 공유할 때 "이 클래스가 실제로 어떤 JSON을 주고받는가"를 확인하거나, API 문서·Mock 서버에 넣을 요청 본문 샘플이 필요할 때 쓰기 좋습니다.
import, package 줄과 메서드가 섞여 있어도 그대로 두면 됩니다.최상위 타입은 보통 자동으로 두면 됩니다. 다른 클래스가 참조하지 않는 첫 클래스가 최상위가 되며, 원하는 클래스를 목록에서 직접 고를 수도 있습니다.Money)은 null로 채워지고, 옵션 줄에 그 이름이 따로 표시됩니다. 해당 클래스도 함께 붙여넣으면 채워집니다.@Serializable
data class Article(
val id: Long,
val title: String,
@SerialName("author_name") val authorName: String,
val status: PostStatus = PostStatus.DRAFT,
val tags: List<String> = emptyList(),
val publishedAt: Instant? = null,
@Transient val cachedHtml: String = "",
)
@Serializable
enum class PostStatus {
@SerialName("draft") DRAFT,
@SerialName("published") PUBLISHED,
}{
"id": 0,
"title": "",
"author_name": "",
"status": "draft",
"tags": [
""
],
"publishedAt": "1970-01-01T00:00:00Z"
}authorName은 @SerialName 덕분에 author_name 키로 나오고, status는 기본값 PostStatus.DRAFT가 enum 항목의 @SerialName을 따라 "draft"가 됩니다. @Transient가 붙은 cachedHtml은 결과에서 빠집니다. publishedAt처럼 기본값이 null인 nullable 필드는 null 대신 타입에 맞는 예시 값(Instant → ISO 시각)으로 채웁니다.
@SerialName, Jackson @JsonProperty, Gson @SerializedName, Moshi @Json(name = ...).@Transient·@JsonIgnore가 붙은 프로퍼티, private 프로퍼티, by lazy 같은 위임 프로퍼티, get()만 있는 계산 프로퍼티, const와 companion object.Status.PAID처럼 enum 항목을 가리키면 해당 항목의 JSON 값으로 바꿉니다.@SerialName이 있으면 그 이름을 씁니다.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant·OffsetDateTime → Z가 붙은 ISO 문자열, Duration → PT0S, UUID도 형식에 맞는 값.List·Set·Array는 예시 원소 하나를 넣고, Map<Int, V>처럼 키가 숫자 타입이면 키를 "0"으로 둡니다.null이나 빈 배열로 끊습니다.응답 DTO를 그대로 붙여넣으면 OpenAPI example이나 README에 넣을 JSON 뼈대가 바로 나옵니다. 키 이름이 @SerialName으로 바뀐 필드도 실제 직렬화 결과와 같은 이름으로 확인할 수 있습니다.
Retrofit 인터페이스가 받는 모델로 MockWebServer나 로컬 JSON 파일에 넣을 응답을 만들 때 유용합니다. 생성된 빈 값("", 0)만 실제 데이터처럼 바꾸면 구조는 모델과 어긋나지 않습니다.
서버 팀에 "우리 앱은 이 모양으로 보낸다"를 전달하거나, 받은 스펙과 Kotlin 모델의 키 이름이 일치하는지 눈으로 대조할 때 씁니다.
"", 0, false)으로 채운 예시이므로, 문서에 쓸 때는 의미 있는 값으로 바꿔 주세요.String?) 필드도 null이 아니라 타입의 예시 값으로 나옵니다. 응답에서 실제로 null이 올 수 있는지는 별도로 표시해야 합니다.@JsonNaming이나 kotlinx JsonNamingStrategy 같은 전역 이름 규칙은 적용하지 않습니다. 어노테이션이 없는 프로퍼티는 Kotlin 이름 그대로 키가 됩니다.type 판별 필드)과 커스텀 KSerializer는 반영하지 않습니다.emptyList()나 listOf(...)처럼 함수 호출로 된 기본값은 예시 값으로 쓰지 않고 타입에서 값을 만듭니다.@Transient 프로퍼티가 결과에 없는데 정상인가요?네. kotlinx.serialization의 @Transient와 Jackson의 @JsonIgnore는 직렬화에서 빠지는 필드라 예시 JSON에서도 제외합니다. 생성자 밖 본문의 private val도 같은 이유로 나오지 않습니다.
클래스 구조는 같기 때문에 그대로 읽습니다. 이름 변경은 Gson @SerializedName("..."), Moshi @Json(name = "...")을 인식합니다.
= null 기본값을 줬는데 왜 null이 아니라 값이 나오나요?예시 JSON은 필드의 모양을 보여 주는 것이 목적이라, null 기본값은 무시하고 타입에 맞는 샘플을 넣습니다. 그래야 Instant?가 어떤 형식의 문자열로 오가는지 확인할 수 있습니다.
필요한 클래스를 한 입력 칸에 이어서 붙여넣으면 됩니다. 정의가 빠진 타입은 옵션 줄에 이름이 표시되므로 무엇을 더 넣어야 하는지 알 수 있습니다.