JSON in Kotlin-data class umwandeln!

Gib JSON ein, um Kotlin-data class-Code inklusive verschachtelter Objekte zu erzeugen! Unterstützt kotlinx.serialization @Serializable, @SerialName, Jackson.
JSON
Ergebnis
 

JSON in Kotlin-data class umwandeln!

Füge eine API-Antwort oder ein Konfigurations-JSON ein und erhalte Kotlin-Code mit data class, der dessen Struktur abbildet. Verschachtelte Objekte und Arrays von Objekten werden jeweils zu eigenen Klassen, und als Ziel kannst du kotlinx.serialization oder Jackson wählen.

Gedacht ist das für den Moment, in dem du in einer Android-App oder einem Ktor/Spring-Service eine externe API anbindest und das Modellgerüst lieber aus einer Beispielantwort gewinnst, statt es abzutippen. Die Umwandlung läuft komplett in deinem Browser, eine eingefügte interne API-Antwort wird also nirgendwohin gesendet.

So funktioniert es

  1. Füge JSON in das Eingabefeld ein. Eine vollständige echte Antwort ergibt eine bessere Typableitung als eine gekürzte.
  2. Setze Typname auf den Namen der obersten Klasse (Standard Root), zum Beispiel UserResponse.
  3. Wähle unter Serializer kotlinx.serialization oder Jackson, passend zu dem, was dein Projekt bereits verwendet.
  4. Kopiere den erzeugten Code in deine Modelldatei. Typname und Serializer bleiben in der URL, ein Lesezeichen öffnet also dasselbe Setup wieder.

Beispiel

Eingabe (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
Ausgabe (Kotlin · kotlinx.serialization)
import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement

@Serializable
data class Order(
    val orderId: String,
    val paid: Boolean,
    val total: Double,
    val coupon: JsonElement? = null,
    val items: List<Item>
)

@Serializable
data class Item(
    val sku: String,
    val qty: Int,
    @SerialName("gift_wrap") val giftWrap: Boolean? = null
)

Objekte im Array items werden zu einer Klasse Item im Singular, und gift_wrap, das nur im zweiten Element vorkommt, wird zu Boolean? = null. coupon ist immer nur null, sein Typ lässt sich also nicht ableiten; es bleibt JsonElement?, damit du es durch den echten Typ ersetzt.

Unterstützte Funktionen

  • kotlinx.serialization: @Serializable an jeder Klasse, @SerialName an Feldern mit geändertem Namen, dazu die nötigen Imports.
  • Jackson: @JsonProperty nur an Feldern mit geändertem Namen.
  • Keys wie user_name oder home-url werden zu camelCase-Properties (userName, homeUrl), die per Annotation auf den ursprünglichen Key zurückgeführt werden.
  • Kotlin-Schlüsselwörter wie class oder val werden in Backticks gesetzt; Keys, die mit einer Ziffer beginnen, bekommen das Präfix n.
  • Zahlen: Ganzzahlen werden zu Int, Werte über 32 Bit zu Long, und jede Dezimalzahl macht das Feld zu Double.
  • Arrays von Objekten werden aus allen Elementen zu einer Klasse zusammengeführt; Felder, die nur in manchen Elementen vorkommen, werden zu ? = null.
  • Ein Array oder primitiver Wert auf oberster Ebene erzeugt einen typealias, z. B. typealias Root = List<RootItem>.

Anwendungsfälle

Response-Modelle für Retrofit- oder Ktor-Clients

Füge eine aus Postman oder den DevTools des Browsers kopierte Antwort ein und du bekommst Klassen, die für Call<Order> oder client.get<Order>() bereit sind. Bei Antworten mit Dutzenden Feldern vermeidest du so Tippfehler und falsche Typen durch Abschreiben.

Eine snake_case-API auf Kotlin-Benennung abbilden

Sendet das Backend created_at, liest die Kotlin-Seite createdAt, während der Serial Name den ursprünglichen Key behält. Die Zuordnung bleibt pro Klasse sichtbar, statt von einer globalen Naming-Strategie abzuhängen.

Migration zu kotlinx.serialization

Ziehst du Gson- oder Jackson-Modelle zu kotlinx.serialization um, erzeuge beide Ausgaben aus demselben JSON, um genau zu sehen, welche Annotationen sich ändern.

Hinweise und Einschränkungen

  • Typen werden nur aus dem eingefügten Beispiel abgeleitet. Ein Feld, das in jedem Beispielelement vorkommt, wird non-null; ergänze ? selbst bei Feldern, die laut API-Doku fehlen dürfen.
  • Datums-Strings wie 2024-01-01T00:00:00Z bleiben String; für einen Wechsel zu Instant brauchst du einen eigenen Serializer.
  • kotlinx.serialization kann Any nicht serialisieren, daher werden Werte ohne ableitbaren Typ dort zu JsonElement und bei Jackson zu Any.
  • Es werden keine Enums, Sealed Classes oder Standardwerte (wie leere Listen) erzeugt. Felder mit einer festen Wertemenge lohnt es sich nachträglich in Enums zu verwandeln.
  • Alle Klassen kommen in einem Block; Package-Deklarationen und das Aufteilen in Dateien übernimmst du.

Häufige Fragen

Warum ist ein Feld String? = null und nicht einfach String??

kotlinx.serialization wirft MissingFieldException, wenn ein Key fehlt und die Property keinen Standardwert hat. Mit = null an Feldern, die in manchen Elementen fehlen oder null enthalten, lassen sich Antworten ohne diesen Key sauber dekodieren.

Kann ich JSON-Keys ohne @SerialName als Property-Namen behalten?

Das Tool wandelt immer in camelCase um und ergänzt eine Annotation nur, wenn der Name abweicht; Keys, die bereits camelCase sind, kommen also ohne Annotation heraus. Um snake_case-Namen zu behalten, benenne die Properties nach dem Erzeugen um und entferne die Annotationen.

Brauche ich jackson-module-kotlin, wenn ich Jackson wähle?

Ja. Die erzeugte data class hat keinen parameterlosen Konstruktor, daher muss jackson-module-kotlin registriert sein, damit Jackson Werte über Konstruktorparameter bindet (Spring Boot registriert es automatisch, wenn die Abhängigkeit vorhanden ist).

Kann es Moshi- oder Gson-Modelle erzeugen?

Als Serializer stehen kotlinx.serialization und Jackson zur Wahl. Für Gson nimmst du die Jackson-Ausgabe und ersetzt @JsonProperty durch @SerializedName; für Moshi verwendest du @Json(name = ...). Die Klassenstruktur bleibt gleich.