Dán một data class Kotlin có sẵn để xem nó trông như thế nào sau khi serialize, dưới dạng một tài liệu JSON mẫu. Class lồng nhau, property List/Map và enum đều được lần theo và điền giá trị, còn annotation đổi tên như @SerialName được áp dụng cho key.
Hãy dùng nó khi server và app dùng chung model và bạn cần xác nhận một class thực sự gửi và nhận JSON nào, hoặc khi tài liệu API hay mock server cần một body request mẫu.
import/package và hàm thành viên có thể để lại; chúng được bỏ qua.Kiểu gốc ở Tự động: class đầu tiên không bị class khác tham chiếu sẽ thành gốc. Bạn cũng có thể chọn một class cụ thể trong danh sách.Money từ file khác) ra dạng null, và tên của chúng được liệt kê bên cạnh các option. Dán thêm các class đó là chúng được điền giá trị.@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 được xuất thành author_name nhờ @SerialName, và giá trị mặc định PostStatus.DRAFT được phân giải thành "draft" qua @SerialName riêng của entry enum đó. cachedHtml được đánh dấu @Transient nên bị bỏ. Property nullable có mặc định null, như publishedAt, vẫn nhận giá trị mẫu theo kiểu (Instant → timestamp ISO) chứ không phải null.
@SerialName của kotlinx.serialization, @JsonProperty của Jackson, @SerializedName của Gson và @Json(name = ...) của Moshi.@Transient hoặc @JsonIgnore, property private, property ủy quyền như by lazy, computed property chỉ có getter, giá trị const và member của companion object.Status.PAID thành giá trị JSON của entry đó.@SerialName ở cấp entry.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → chuỗi ISO kết thúc bằng Z, Duration → PT0S; UUID nhận giá trị đúng định dạng.List, Set và Array có một phần tử mẫu; map có kiểu key là số như Map<Int, V> dùng "0" làm key.null hoặc mảng rỗng thay vì mở rộng vô hạn.Dán một DTO response là có khung JSON cho example của OpenAPI hoặc README. Field đổi tên qua @SerialName xuất hiện đúng dưới cái tên mà serializer sẽ thực sự ghi ra.
Dựng body cho MockWebServer hoặc JSON fixture cục bộ từ chính model mà interface Retrofit trả về. Thay các giá trị giữ chỗ ("", 0) bằng dữ liệu thực tế mà cấu trúc vẫn khớp với model.
Cho đội server thấy chính xác những gì app gửi đi, hoặc so một spec nhận được với model Kotlin để bắt lỗi lệch tên key trước khi chúng thành lỗi runtime.
"", 0, false), không phải dữ liệu thực tế; hãy thay chúng trước khi công bố tài liệu.String?) cũng nhận giá trị mẫu theo kiểu thay vì null, nên hãy đánh dấu riêng những field thực sự có thể là null.@JsonNaming của Jackson hay JsonNamingStrategy của kotlinx không được áp dụng; property không có annotation giữ tên Kotlin làm key.type) và KSerializer tùy biến không được phản ánh.emptyList() hay listOf(...), không được tính; giá trị lấy theo kiểu đã khai báo.@Transient bị thiếu trong output. Như vậy có đúng không?Đúng. @Transient của kotlinx.serialization và @JsonIgnore của Jackson giữ field ngoài quá trình serialize, nên mẫu cũng bỏ nó. private val khai báo trong thân class bị bỏ ra vì cùng lý do.
Cú pháp class giống nhau nên parse bình thường. Việc đổi tên từ @SerializedName("...") của Gson và @Json(name = "...") của Moshi đều được nhận ra.
= null, sao field vẫn có giá trị?Mục tiêu là cho thấy hình dạng của từng field, nên mặc định null bị bỏ qua và giá trị mẫu theo kiểu được dùng. Nhờ vậy bạn thấy được, chẳng hạn, một Instant? được truyền đi dưới định dạng chuỗi nào.
Dán lần lượt từng file vào cùng một ô nhập. Kiểu nào vẫn còn thiếu sẽ được nêu tên cạnh các option, cho bạn biết cần thêm gì nữa.