Tampal data class Kotlin sedia ada dan lihat rupanya setelah disiri, sebagai dokumen JSON sampel. Kelas bersarang, property List/Map dan enum diikuti dan diisi, dan anotasi penamaan semula seperti @SerialName dikenakan pada kunci.
Gunakannya apabila pelayan dan aplikasi berkongsi model dan anda perlu mengesahkan JSON yang sebenarnya dihantar dan diterima oleh sesuatu kelas, atau apabila dokumentasi API atau mock server memerlukan sampel badan permintaan.
import/package dan fungsi ahli boleh dibiarkan; ia akan dilangkau.Jenis akar pada Automatik dalam kebanyakan kes: kelas pertama yang tidak dirujuk oleh kelas lain menjadi akar. Anda juga boleh memilih kelas tertentu daripada senarai.Money daripada fail lain) dikeluarkan sebagai null, dan namanya disenaraikan di sebelah pilihan. Tampal kelas tersebut juga dan ia akan diisi.@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 kerana @SerialName, dan nilai lalai PostStatus.DRAFT menjadi "draft" melalui @SerialName milik entri enum itu sendiri. cachedHtml ditanda @Transient, jadi ia digugurkan. Property nullable yang lalainya null, seperti publishedAt, tetap mendapat sampel bertaip (Instant → cap masa ISO) dan bukan null.
@SerialName kotlinx.serialization, @JsonProperty Jackson, @SerializedName Gson dan @Json(name = ...) Moshi.@Transient atau @JsonIgnore, property private, property delegasi seperti by lazy, computed property yang hanya ada getter, nilai const dan ahli companion object.Status.PAID menjadi nilai JSON entri tersebut.@SerialName di peringkat entri.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → rentetan ISO berakhir dengan Z, Duration → PT0S; UUID mendapat nilai yang berformat betul.List, Set dan Array mendapat satu elemen sampel; map dengan jenis kunci numerik seperti Map<Int, V> menggunakan "0" sebagai kunci.null atau tatasusunan kosong dan tidak dikembangkan tanpa henti.Tampal DTO respons dan anda mendapat rangka JSON untuk example OpenAPI atau README. Medan yang dinamakan semula melalui @SerialName muncul dengan nama yang sama seperti yang akan ditulis oleh serializer.
Bina badan untuk MockWebServer atau fixture JSON tempatan daripada model yang sama yang dipulangkan oleh interface Retrofit anda. Gantikan nilai pemegang tempat ("", 0) dengan data realistik dan strukturnya tetap sepadan dengan model.
Tunjukkan kepada pasukan pelayan dengan tepat apa yang dihantar aplikasi, atau bandingkan spesifikasi yang diterima dengan model Kotlin anda untuk mengesan ketidakpadanan nama kunci sebelum ia menjadi ralat masa jalan.
"", 0, false), bukan data realistik; gantikannya sebelum menerbitkan dokumentasi.String?) juga mendapat sampel bertaip dan bukan null, jadi tandakan secara berasingan medan mana yang sebenarnya boleh null.@JsonNaming Jackson atau JsonNamingStrategy kotlinx tidak dikenakan; property tanpa anotasi mengekalkan nama Kotlin-nya sebagai kunci.type) dan KSerializer tersuai tidak dicerminkan.emptyList() atau listOf(...), tidak dinilai; nilainya diambil daripada jenis yang diisytiharkan.@Transient tiada dalam output. Adakah itu dijangka?Ya. @Transient kotlinx.serialization dan @JsonIgnore Jackson mengecualikan medan daripada penyirian, jadi sampel juga meninggalkannya. private val yang diisytiharkan dalam badan kelas ditinggalkan atas sebab yang sama.
Sintaks kelasnya sama, jadi ia dihurai tanpa masalah. Penamaan semula daripada @SerializedName("...") Gson dan @Json(name = "...") Moshi dikenali.
= null, jadi mengapa medan itu mempunyai nilai?Matlamatnya adalah untuk menunjukkan bentuk setiap medan, jadi nilai lalai null diabaikan dan sampel bertaip digunakan. Dengan cara itu anda boleh melihat, contohnya, format rentetan yang digunakan untuk menghantar Instant?.
Tampal satu demi satu ke dalam input yang sama. Mana-mana jenis yang masih tiada akan dinamakan di sebelah pilihan, yang memberitahu anda apa lagi yang perlu ditambah.