Tukar kelas Kotlin kepada JSON!

Tampal kod Kotlin (data class) dan dapatkan contoh JSON! Menyokong kotlinx.serialization @SerialName, Jackson, Gson, Moshi. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Kotlin
Hasil
 

Tukar kelas Kotlin kepada JSON!

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.

Cara menggunakan

  1. Tampal sumber Kotlin anda. Baris import/package dan fungsi ahli boleh dibiarkan; ia akan dilangkau.
  2. Biarkan 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.
  3. Salin JSON ke dalam contoh Swagger, badan permintaan Postman atau fixture ujian.
  4. Jenis yang ditakrifkan di tempat lain (contohnya kelas Money daripada fail lain) dikeluarkan sebagai null, dan namanya disenaraikan di sebelah pilihan. Tampal kelas tersebut juga dan ia akan diisi.

Contoh

Input (Kotlin)
@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,
}
Output (JSON)
{
  "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.

Ciri yang disokong

  • Penamaan semula kunci: @SerialName kotlinx.serialization, @JsonProperty Jackson, @SerializedName Gson dan @Json(name = ...) Moshi.
  • Dikecualikan: property bertanda @Transient atau @JsonIgnore, property private, property delegasi seperti by lazy, computed property yang hanya ada getter, nilai const dan ahli companion object.
  • Nilai lalai literal rentetan, nombor dan boolean digunakan sebagai nilai sampel; nilai lalai seperti Status.PAID menjadi nilai JSON entri tersebut.
  • Enum menggunakan entri pertamanya, dengan mengambil kira @SerialName di peringkat entri.
  • Tarikh dan masa: 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.
  • Kelas yang merujuk dirinya sendiri (pokok, komen berbenang) dihentikan dengan null atau tatasusunan kosong dan tidak dikembangkan tanpa henti.

Kes penggunaan

Dokumentasi API untuk servis Ktor atau Spring

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.

Respons palsu untuk ujian Android

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.

Menyepakati nama kunci dengan backend

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.

Nota dan had

  • Nilai ialah pemegang tempat jenis ("", 0, false), bukan data realistik; gantikannya sebelum menerbitkan dokumentasi.
  • Property nullable (String?) juga mendapat sampel bertaip dan bukan null, jadi tandakan secara berasingan medan mana yang sebenarnya boleh null.
  • Peraturan penamaan global seperti @JsonNaming Jackson atau JsonNamingStrategy kotlinx tidak dikenakan; property tanpa anotasi mengekalkan nama Kotlin-nya sebagai kunci.
  • Hierarki sealed polimorfik (diskriminator type) dan KSerializer tersuai tidak dicerminkan.
  • Nilai lalai yang dibina daripada panggilan fungsi, seperti emptyList() atau listOf(...), tidak dinilai; nilainya diambil daripada jenis yang diisytiharkan.

Soalan lazim

Property @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.

Adakah ia membaca model yang ditulis untuk Gson atau Moshi?

Sintaks kelasnya sama, jadi ia dihurai tanpa masalah. Penamaan semula daripada @SerializedName("...") Gson dan @Json(name = "...") Moshi dikenali.

Saya mengisytiharkan = 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?.

Kelas saya berada dalam beberapa fail. Apa yang perlu saya tampal?

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.