Collez une réponse d'API ou un JSON de configuration et obtenez du code Kotlin data class qui reproduit sa structure. Les objets imbriqués et les tableaux d'objets deviennent chacun leur propre classe, et vous pouvez cibler kotlinx.serialization ou Jackson.
C'est pensé pour le moment où vous branchez une API externe dans une application Android ou un service Ktor/Spring et voulez le squelette du modèle à partir d'une seule réponse d'exemple, au lieu de le taper. La conversion s'exécute entièrement dans votre navigateur : coller la réponse d'une API interne ne l'envoie nulle part.
Nom du type le nom de la classe de premier niveau (par défaut Root), par exemple UserResponse.Sérialiseur, selon ce que votre projet utilise déjà.{
"orderId": "A-1024",
"paid": true,
"total": 39.9,
"coupon": null,
"items": [
{ "sku": "TSHIRT-M", "qty": 2 },
{ "sku": "CAP", "qty": 1, "gift_wrap": true }
]
}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
)
Les objets du tableau items deviennent une classe au singulier Item, et gift_wrap, qui n'apparaît que dans le deuxième élément, devient Boolean? = null. coupon ne vaut jamais que null : son type ne peut pas être inféré et il reste JsonElement?, à remplacer par le vrai type.
@Serializable sur chaque classe, @SerialName sur les champs dont le nom a changé, plus les imports nécessaires.@JsonProperty uniquement sur les champs dont le nom a changé.user_name ou home-url deviennent des propriétés camelCase (userName, homeUrl) reliées à la clé d'origine par annotation.class ou val sont entourés de backticks ; les clés commençant par un chiffre reçoivent un préfixe n.Int, les valeurs au-delà de 32 bits Long, et la moindre décimale fait passer le champ en Double.? = null.typealias, par exemple typealias Root = List<RootItem>.Collez une réponse copiée depuis Postman ou les DevTools du navigateur et vous obtenez des classes prêtes pour Call<Order> ou client.get<Order>(). Avec des réponses à plusieurs dizaines de champs, cela évite les fautes de frappe et les mauvais types d'une copie manuelle.
Quand le backend envoie created_at, le côté Kotlin lit createdAt tandis que le serial name garde la clé d'origine. Le mapping reste visible classe par classe au lieu de dépendre d'une stratégie de nommage globale.
Si vous passez des modèles Gson ou Jackson à kotlinx.serialization, générez les deux sorties à partir du même JSON pour voir exactement quelles annotations changent.
? aux champs que la doc de l'API dit facultatifs.2024-01-01T00:00:00Z restent String ; passer à Instant demande votre propre sérialiseur.Any : les valeurs sans type inférable deviennent JsonElement avec ce sérialiseur, et Any avec Jackson.String? = null plutôt que simplement String? ?kotlinx.serialization lève MissingFieldException quand une clé est absente et que la propriété n'a pas de valeur par défaut. Ajouter = null aux champs absents de certains éléments ou contenant null permet de décoder sans erreur les réponses dépourvues de cette clé.
@SerialName ?L'outil convertit toujours en camelCase et n'ajoute une annotation que si le nom diffère : les clés déjà en camelCase sortent sans annotation. Pour garder des noms snake_case, renommez les propriétés et retirez les annotations après génération.
Oui. La data class générée n'a pas de constructeur sans argument : Jackson a donc besoin que jackson-module-kotlin soit enregistré pour lier les valeurs via les paramètres du constructeur (Spring Boot l'enregistre automatiquement quand la dépendance est présente).
Les options de sérialiseur sont kotlinx.serialization et Jackson. Pour Gson, prenez la sortie Jackson et remplacez @JsonProperty par @SerializedName ; pour Moshi, utilisez @Json(name = ...). La structure des classes reste la même.