API 응답이나 설정 JSON을 붙여넣으면 그 구조 그대로 Kotlin data class를 만들어 줍니다. 중첩 객체와 객체 배열은 각각 별도의 클래스로 나뉘고, 직렬화 라이브러리로 kotlinx.serialization과 Jackson 중 하나를 고를 수 있습니다.
Android 앱이나 Ktor·Spring 서버에서 외부 API를 붙일 때, 응답 예시 하나로 모델 클래스의 뼈대를 빠르게 잡고 싶은 경우에 맞춰져 있습니다. 변환은 브라우저 안에서만 이루어지므로 사내 API 응답을 붙여넣어도 서버로 전송되지 않습니다.
타입 이름에 최상위 클래스 이름을 적습니다(기본값 Root). 예: UserResponse.직렬화 라이브러리에서 kotlinx.serialization 또는 Jackson을 고릅니다. 프로젝트에서 이미 쓰는 쪽을 고르면 됩니다.{
"orderId": "A-1024",
"paid": true,
"total": 39.9,
"coupon": null,
"items": [
{ "sku": "TSHIRT-M", "qty": 2 },
{ "sku": "CAP", "qty": 1, "gift_wrap": true }
]
}import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement
@Serializable
data class Order(
val orderId: String,
val paid: Boolean,
val total: Double,
val coupon: JsonElement? = null,
val items: List<Item>
)
@Serializable
data class Item(
val sku: String,
val qty: Int,
@SerialName("gift_wrap") val giftWrap: Boolean? = null
)
items 배열 안 객체는 단수형 이름 Item 클래스가 되고, 두 번째 항목에만 있는 gift_wrap은 Boolean? = null이 됩니다. 값이 null뿐이라 타입을 알 수 없는 coupon은 JsonElement?로 남겨 두었으니 실제 타입으로 바꿔 주세요.
@Serializable, 키 이름이 바뀐 필드에 @SerialName을 붙이고 필요한 import를 함께 넣습니다.@JsonProperty를 붙입니다.user_name, home-url 같은 키는 userName, homeUrl 같은 camelCase 프로퍼티로 바꾸고 원래 키는 어노테이션으로 연결합니다.class, val 같은 Kotlin 예약어 키는 백틱으로 감싸고, 숫자로 시작하는 키는 앞에 n을 붙입니다.Int, 32비트 범위를 넘으면 Long, 소수가 섞이면 Double.? = null로 만듭니다.typealias Root = List<RootItem>처럼 별칭을 만듭니다.Postman이나 브라우저 개발자 도구에서 복사한 응답을 넣으면 Call<Order>, client.get<Order>()에 바로 쓸 수 있는 클래스가 나옵니다. 필드가 수십 개인 응답을 손으로 옮길 때 생기는 오타와 타입 실수를 줄일 수 있습니다.
백엔드가 created_at 같은 snake_case를 쓰더라도 Kotlin 쪽은 createdAt으로 쓰고 직렬화 이름만 원래 키를 유지합니다. 전역 naming strategy를 바꾸지 않고 클래스 단위로 매핑이 드러나는 방식입니다.
Gson·Jackson 모델을 kotlinx.serialization으로 바꾸는 중이라면 같은 JSON으로 두 가지 출력을 비교해 보며 어노테이션 차이를 확인할 수 있습니다.
?를 붙여 주세요.2024-01-01T00:00:00Z)은 String으로 나옵니다. Instant 등으로 바꾸려면 직접 serializer를 지정해야 합니다.Any를 직렬화하지 못해서 타입을 정할 수 없는 값은 JsonElement로, Jackson에서는 Any로 둡니다.String?이 아니라 String? = null로 나오나요?kotlinx.serialization은 JSON에 키가 아예 없을 때 기본값이 없으면 MissingFieldException을 던집니다. 일부 항목에만 있거나 null이 섞인 필드에 = null을 붙여 두면 키가 빠진 응답도 문제없이 디코딩됩니다.
@SerialName을 쓰지 않고 JSON 키를 그대로 프로퍼티 이름으로 쓸 수 있나요?이 도구는 항상 camelCase로 바꾸고 다를 때만 어노테이션을 붙입니다. 키가 이미 camelCase라면 어노테이션 없이 그대로 나옵니다. snake_case 이름을 그대로 쓰고 싶다면 생성 후 프로퍼티 이름을 바꾸고 어노테이션을 지우면 됩니다.
네. 생성되는 클래스는 기본 생성자가 없는 data class라서 Jackson이 생성자 파라미터로 값을 넣으려면 jackson-module-kotlin을 등록해야 합니다(Spring Boot는 의존성만 있으면 자동 등록).
출력 옵션은 kotlinx.serialization과 Jackson 두 가지입니다. Gson은 Jackson 출력에서 @JsonProperty를 @SerializedName으로, Moshi는 @Json(name = ...)으로 바꾸면 같은 구조로 쓸 수 있습니다.