Tempel respons API atau JSON config dan dapatkan kode data class Kotlin yang mencerminkan strukturnya. Objek bersarang dan array objek masing-masing menjadi class sendiri, dan Anda bisa menargetkan kotlinx.serialization atau Jackson.
Alat ini dibuat untuk saat Anda menyambungkan API eksternal di aplikasi Android atau service Ktor/Spring dan ingin kerangka model dari satu contoh respons alih-alih mengetiknya manual. Konversi berjalan sepenuhnya di browser Anda, jadi menempel respons API internal tidak mengirimnya ke mana pun.
Nama tipe dengan nama class tingkat atas (default Root), misalnya UserResponse.Serializer, sesuai yang sudah dipakai proyek Anda.{
"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
)
Objek di dalam array items menjadi class Item dalam bentuk tunggal, dan gift_wrap, yang hanya muncul di item kedua, menjadi Boolean? = null. coupon selalu bernilai null, jadi tipenya tidak bisa disimpulkan dan dibiarkan sebagai JsonElement? agar Anda ganti dengan tipe sebenarnya.
@Serializable di setiap class, @SerialName pada field yang namanya berubah, ditambah import yang diperlukan.@JsonProperty hanya pada field yang namanya berubah.user_name atau home-url menjadi properti camelCase (userName, homeUrl) yang dipetakan kembali ke key aslinya lewat anotasi.class atau val dibungkus backtick; key yang diawali angka diberi prefix n.Int, nilai di atas 32-bit menjadi Long, dan desimal apa pun menjadikan field Double.? = null.typealias, misalnya typealias Root = List<RootItem>.Tempel respons yang disalin dari Postman atau DevTools browser dan Anda mendapat class yang siap untuk Call<Order> atau client.get<Order>(). Untuk respons dengan puluhan field, ini menghindari salah ketik dan salah tipe akibat menyalin manual.
Ketika backend mengirim created_at, sisi Kotlin membaca createdAt sementara serial name mempertahankan key aslinya. Pemetaannya terlihat per class, tidak bergantung pada naming strategy global.
Jika Anda memindahkan model Gson atau Jackson ke kotlinx.serialization, buat kedua output dari JSON yang sama untuk melihat persis anotasi mana yang berubah.
? untuk field yang menurut dokumentasi API bisa dihilangkan.2024-01-01T00:00:00Z tetap String; beralih ke Instant memerlukan serializer Anda sendiri.Any, jadi nilai yang tipenya tidak bisa disimpulkan menjadi JsonElement di sana dan Any di Jackson.String? = null dan bukan sekadar String??kotlinx.serialization melempar MissingFieldException ketika sebuah key tidak ada dan propertinya tidak punya default. Menambahkan = null pada field yang tidak ada di sebagian item atau berisi null membuat respons tanpa key itu tetap ter-decode dengan lancar.
@SerialName?Alat ini selalu mengonversi ke camelCase dan hanya menambahkan anotasi jika namanya berbeda, jadi key yang sudah camelCase keluar tanpa anotasi. Untuk mempertahankan nama snake_case, ganti nama propertinya dan hapus anotasinya setelah kode dibuat.
Ya. data class yang dihasilkan tidak punya constructor tanpa argumen, jadi Jackson perlu jackson-module-kotlin yang terdaftar untuk mengikat nilai lewat parameter constructor (Spring Boot mendaftarkannya otomatis jika dependensinya ada).
Opsi serializer-nya adalah kotlinx.serialization dan Jackson. Untuk Gson, ambil output Jackson dan ganti @JsonProperty dengan @SerializedName; untuk Moshi, gunakan @Json(name = ...). Struktur class-nya tetap sama.