I-paste ang isang existing na Kotlin data class at tingnan kung ano ang itsura nito kapag na-serialize na, bilang sample JSON document. Sinusundan at pinupunan ang mga nested class, List/Map property at enum, at ina-apply sa mga key ang mga annotation na nagpapalit ng pangalan gaya ng @SerialName.
Gamitin ito kapag magkasalo ng model ang server at app at kailangan mong kumpirmahin kung aling JSON talaga ang ipinapadala at tinatanggap ng isang class, o kapag kailangan ng sample na request body para sa API doc o mock server.
import/package at mga member function; nilalaktawan sila.Awtomatiko ang Root type: ang unang class na hindi nire-reference ng ibang class ang nagiging root. Puwede ka ring pumili ng partikular na class mula sa listahan.null ang mga type na dine-define sa ibang lugar (halimbawa, isang Money class mula sa ibang file), at nakalista ang mga pangalan nila sa tabi ng mga option. I-paste rin ang mga class na iyon at mapupunan sila.@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"
}Inilalabas ang authorName bilang author_name dahil sa @SerialName, at nare-resolve sa "draft" ang default na PostStatus.DRAFT sa pamamagitan ng sariling @SerialName ng enum entry. May marka ang cachedHtml na @Transient, kaya tinatanggal ito. Nakakakuha pa rin ng typed na sample (Instant → ISO timestamp) sa halip na null ang nullable na property na null ang default, gaya ng publishedAt.
@SerialName ng kotlinx.serialization, @JsonProperty ng Jackson, @SerializedName ng Gson at @Json(name = ...) ng Moshi.@Transient o @JsonIgnore, mga private property, mga delegated gaya ng by lazy, mga getter-only na computed property, mga const value at mga member ng companion object.Status.PAID.@SerialName sa level ng entry.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → ISO string na nagtatapos sa Z, Duration → PT0S; may maayos na anyong value ang UUID.List, Set at Array; gumagamit ng "0" bilang key ang map na may numeric key type gaya ng Map<Int, V>.null o empty array ang mga self-referencing class (tree, threaded comment) sa halip na lumawak nang walang hanggan.I-paste ang isang response DTO at mayroon ka nang JSON skeleton para sa isang OpenAPI example o README. Lumalabas ang mga field na pinalitan ng pangalan gamit ang @SerialName sa parehong pangalan na talagang isusulat ng serializer.
Buuin ang body para sa MockWebServer o isang local JSON fixture mula sa mismong model na ibinabalik ng Retrofit interface mo. Palitan ng makatotohanang data ang mga placeholder value ("", 0) at tugma pa rin sa model ang istruktura.
Ipakita sa server team kung ano mismo ang ipinapadala ng app, o ikumpara ang natanggap na spec sa Kotlin model mo para mahuli ang mga hindi tugmang key name bago sila maging runtime error.
"", 0, false) ang mga value, hindi makatotohanang data; palitan sila bago mag-publish ng docs.null ang mga nullable na property (String?), kaya hiwalay na markahan kung aling mga field ang talagang puwedeng null.@JsonNaming ng Jackson o JsonNamingStrategy ng kotlinx; napapanatili ng mga property na walang annotation ang Kotlin name nila bilang key.type discriminator) at mga custom na KSerializer.emptyList() o listOf(...); galing na lang sa naka-declare na type ang value.@Transient property. Inaasahan ba iyon?Oo. Inilalayo ng @Transient ng kotlinx.serialization at @JsonIgnore ng Jackson ang field sa serialization, kaya hindi rin ito isinasama ng sample. Sa parehong dahilan, hindi isinasama ang private val na naka-declare sa class body.
Pareho ang class syntax, kaya maayos silang napa-parse. Kinikilala ang mga rename mula sa @SerializedName("...") ng Gson at @Json(name = "...") ng Moshi.
= null, kaya bakit may value ang field?Layunin nitong ipakita ang hugis ng bawat field, kaya hindi pinapansin ang default na null at typed na sample ang ginagamit. Sa ganoon, makikita mo, halimbawa, kung anong string format ang dala ng isang Instant?.
I-paste sila nang sunud-sunod sa parehong input. Pinapangalanan sa tabi ng mga option ang anumang type na nawawala pa, kaya malalaman mo kung ano pa ang idadagdag.