Füge eine bestehende Kotlin-data class ein und sieh als Beispiel-JSON-Dokument, wie sie serialisiert aussieht. Verschachtelte Klassen, List/Map-Properties und Enums werden verfolgt und befüllt, und Annotationen zum Umbenennen wie @SerialName werden auf die Keys angewendet.
Greif darauf zurück, wenn Server und App Modelle teilen und du bestätigen musst, welches JSON eine Klasse wirklich sendet und empfängt, oder wenn eine API-Doku oder ein Mock-Server ein Beispiel für einen Request-Body braucht.
import/package-Zeilen und Member-Funktionen dürfen drinbleiben; sie werden übersprungen.Wurzeltyp meist auf Automatisch: Die erste Klasse, auf die keine andere Klasse verweist, wird zur Wurzel. Du kannst auch eine bestimmte Klasse aus der Liste wählen.Money aus einer anderen Datei) kommen als null heraus, und ihre Namen werden neben den Optionen aufgelistet. Füge diese Klassen ebenfalls ein, dann werden sie befüllt.@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 wird wegen @SerialName als author_name ausgegeben, und der Standardwert PostStatus.DRAFT wird über das eigene @SerialName des Enum-Eintrags zu "draft" aufgelöst. cachedHtml ist mit @Transient markiert und fällt daher weg. Eine nullable Property mit Standardwert null wie publishedAt bekommt trotzdem ein typisiertes Beispiel (Instant → ISO-Zeitstempel) statt null.
@SerialName von kotlinx.serialization, @JsonProperty von Jackson, @SerializedName von Gson und @Json(name = ...) von Moshi.@Transient oder @JsonIgnore, private Properties, delegierte wie by lazy, berechnete Properties nur mit Getter, const-Werte und Member von companion object.Status.PAID wird zum JSON-Wert dieses Eintrags.@SerialName auf Eintragsebene.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → ISO-String mit Z am Ende, Duration → PT0S; UUID bekommt einen wohlgeformten Wert.List, Set und Array bekommen ein Beispielelement; eine Map mit numerischem Key-Typ wie Map<Int, V> verwendet "0" als Key.null oder einem leeren Array abgeschnitten, statt endlos aufgeklappt zu werden.Füge ein Response-DTO ein, und du hast das JSON-Gerüst für ein OpenAPI-example oder eine README. Über @SerialName umbenannte Felder erscheinen unter demselben Namen, den der Serializer tatsächlich schreibt.
Baue den Body für MockWebServer oder ein lokales JSON-Fixture aus genau dem Modell, das dein Retrofit-Interface zurückgibt. Tausche die Platzhalterwerte ("", 0) gegen realistische Daten, und die Struktur passt weiterhin zum Modell.
Zeig dem Server-Team genau, was die App sendet, oder vergleiche eine erhaltene Spezifikation mit deinem Kotlin-Modell, um abweichende Key-Namen zu finden, bevor sie zu Laufzeitfehlern werden.
"", 0, false), keine realistischen Daten; ersetze sie, bevor du Dokus veröffentlichst.String?) bekommen ein typisiertes Beispiel statt null; markiere also gesondert, welche Felder tatsächlich null sein können.@JsonNaming von Jackson oder JsonNamingStrategy von kotlinx werden nicht angewendet; Properties ohne Annotation behalten ihren Kotlin-Namen als Key.type-Diskriminator) und eigene KSerializer werden nicht abgebildet.emptyList() oder listOf(...) werden nicht ausgewertet; der Wert ergibt sich stattdessen aus dem deklarierten Typ.@Transient-Property fehlt in der Ausgabe. Ist das so gewollt?Ja. @Transient von kotlinx.serialization und @JsonIgnore von Jackson halten ein Feld aus der Serialisierung heraus, daher lässt es auch das Beispiel weg. Ein im Klassenrumpf deklariertes private val fehlt aus demselben Grund.
Die Klassensyntax ist dieselbe, sie werden also problemlos geparst. Umbenennungen über @SerializedName("...") von Gson und @Json(name = "...") von Moshi werden erkannt.
= null deklariert, warum hat das Feld trotzdem einen Wert?Ziel ist es, die Form jedes Feldes zu zeigen, daher wird ein Standardwert null ignoriert und ein typisiertes Beispiel verwendet. So siehst du etwa, in welchem String-Format ein Instant? übertragen wird.
Füge sie nacheinander in dieselbe Eingabe ein. Jeder noch fehlende Typ wird neben den Optionen genannt, so weißt du, was du noch ergänzen musst.