粘贴 API 响应或配置 JSON,就能得到反映其结构的 Kotlin data class 代码。嵌套对象和对象数组各自成为独立的类,目标可以选择 kotlinx.serialization 或 Jackson。
它专为这样的时刻而设计:在 Android 应用或 Ktor/Spring 服务中对接外部 API,想从一份示例响应得到模型骨架,而不是逐字敲出来。转换完全在浏览器中进行,所以粘贴内部 API 的响应也不会被发送到任何地方。
类型名 设为顶层类的名称(默认 Root),例如 UserResponse。序列化库 中选择 kotlinx.serialization 或 Jackson,与项目已在使用的保持一致。{
"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
)
items 数组中的对象变成了单数形式的 Item 类,只在第二项中出现的 gift_wrap 变成 Boolean? = null。coupon 始终是 null,无法推断类型,所以保留为 JsonElement?,留给你换成真实类型。
@Serializable,改名的字段带 @SerialName,并附上所需的 import。@JsonProperty。user_name 或 home-url 这样的 key 变成 camelCase 属性(userName、homeUrl),并通过注解对应回原始 key。class、val 等 Kotlin 关键字会用反引号括起来;以数字开头的 key 会加上 n 前缀。Int,超出 32 位的值为 Long,只要出现小数,字段就是 Double。? = null。typealias,例如 typealias Root = List<RootItem>。粘贴从 Postman 或浏览器 DevTools 复制的响应,就能得到可直接用于 Call<Order> 或 client.get<Order>() 的类。对于有几十个字段的响应,可以避免手动复制时的拼写错误和类型错误。
后端发送 created_at 时,Kotlin 一侧读取 createdAt,而 serial name 保留原始 key。映射关系在每个类中都清晰可见,而不是依赖全局的命名策略。
如果要把 Gson 或 Jackson 模型迁移到 kotlinx.serialization,可以用同一份 JSON 生成两种输出,准确看出哪些注解会变化。
?。2024-01-01T00:00:00Z 这样的日期字符串仍是 String;改用 Instant 需要自己编写序列化器。Any,所以无法推断类型的值在那里变成 JsonElement,在 Jackson 中则是 Any。String? = null 而不只是 String??当 key 不存在且属性没有默认值时,kotlinx.serialization 会抛出 MissingFieldException。给在部分元素中缺失或包含 null 的字段加上 = null,没有该 key 的响应也能顺利解码。
@SerialName,直接把 JSON key 当作属性名吗?本工具总是转换为 camelCase,并且只在名称不同时添加注解,所以本来就是 camelCase 的 key 输出时不带注解。如果想保留 snake_case 名称,请在生成后重命名属性并删掉注解。
需要。生成的 data class 没有无参构造函数,所以 Jackson 需要注册 jackson-module-kotlin,才能通过构造函数参数绑定值(存在该依赖时 Spring Boot 会自动注册)。
序列化库选项只有 kotlinx.serialization 和 Jackson。Gson 可以拿 Jackson 的输出把 @JsonProperty 换成 @SerializedName;Moshi 则使用 @Json(name = ...)。类的结构保持不变。