Tempel data class Kotlin yang sudah ada dan lihat seperti apa bentuknya setelah di-serialize, sebagai contoh dokumen JSON. Class bersarang, properti List/Map, dan enum ditelusuri lalu diisi, dan anotasi penggantian nama seperti @SerialName diterapkan pada key.
Gunakan ketika server dan aplikasi berbagi model dan Anda perlu memastikan JSON apa yang sebenarnya dikirim dan diterima sebuah class, atau ketika dokumentasi API atau mock server membutuhkan contoh body request.
import/package dan member function boleh tetap ada; semuanya dilewati.Tipe akar di Otomatis: class pertama yang tidak direferensikan class lain menjadi root. Anda juga bisa memilih class tertentu dari daftar.Money dari file lain) keluar sebagai null, dan namanya dicantumkan di samping opsi. Tempel juga class-class itu dan semuanya akan terisi.@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 dikeluarkan sebagai author_name karena @SerialName, dan default PostStatus.DRAFT menjadi "draft" lewat @SerialName milik entri enum itu sendiri. cachedHtml ditandai @Transient, jadi dibuang. Properti nullable dengan default null, seperti publishedAt, tetap mendapat contoh sesuai tipenya (Instant → timestamp ISO), bukan null.
@SerialName dari kotlinx.serialization, @JsonProperty dari Jackson, @SerializedName dari Gson, dan @Json(name = ...) dari Moshi.@Transient atau @JsonIgnore, properti private, properti delegasi seperti by lazy, computed property yang hanya punya getter, nilai const, dan member companion object.Status.PAID menjadi nilai JSON dari entri tersebut.@SerialName di level entri.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → string ISO yang diakhiri Z, Duration → PT0S; UUID mendapat nilai yang formatnya valid.List, Set dan Array mendapat satu elemen contoh; map dengan tipe key numerik seperti Map<Int, V> memakai "0" sebagai key.null atau array kosong alih-alih dijabarkan tanpa akhir.Tempel DTO respons dan Anda mendapat kerangka JSON untuk example OpenAPI atau README. Field yang diganti namanya lewat @SerialName muncul dengan nama yang sama seperti yang benar-benar ditulis serializer.
Bangun body untuk MockWebServer atau fixture JSON lokal dari model yang persis dikembalikan interface Retrofit Anda. Ganti nilai placeholder ("", 0) dengan data yang realistis dan strukturnya tetap cocok dengan model.
Tunjukkan ke tim server persis apa yang dikirim aplikasi, atau bandingkan spesifikasi yang diterima dengan model Kotlin Anda untuk menangkap ketidakcocokan nama key sebelum menjadi error runtime.
"", 0, false), bukan data realistis; ganti sebelum memublikasikan dokumentasi.String?) juga mendapat contoh sesuai tipe, bukan null, jadi tandai secara terpisah field mana yang benar-benar bisa null.@JsonNaming dari Jackson atau JsonNamingStrategy dari kotlinx tidak diterapkan; properti tanpa anotasi memakai nama Kotlin-nya sebagai key.type) dan KSerializer kustom tidak tercermin.emptyList() atau listOf(...), tidak dievaluasi; nilainya diambil dari tipe yang dideklarasikan.@Transient tidak ada di output. Apakah memang begitu?Ya. @Transient dari kotlinx.serialization dan @JsonIgnore dari Jackson mengeluarkan field dari serialisasi, jadi contoh juga menghilangkannya. private val yang dideklarasikan di body class tidak disertakan dengan alasan yang sama.
Sintaks class-nya sama, jadi bisa di-parse dengan baik. Penggantian nama dari @SerializedName("...") milik Gson dan @Json(name = "...") milik Moshi dikenali.
= null, jadi mengapa field-nya punya nilai?Tujuannya adalah menunjukkan bentuk setiap field, jadi default null diabaikan dan contoh sesuai tipe yang dipakai. Dengan begitu Anda bisa melihat, misalnya, format string apa yang dipakai Instant? saat dikirim.
Tempel semuanya berurutan ke input yang sama. Tipe yang masih kurang disebutkan namanya di samping opsi, yang memberi tahu Anda apa lagi yang perlu ditambahkan.