Преобразуйте JSON в data class Kotlin!

Введите JSON, чтобы получить код data class на Kotlin, включая вложенные объекты! Поддержка: kotlinx.serialization @Serializable, @SerialName, Jackson.
JSON
Результат
 

Преобразуйте JSON в data class Kotlin!

Вставьте ответ API или JSON конфигурации и получите код data class на Kotlin, повторяющий его структуру. Вложенные объекты и массивы объектов становятся отдельными классами, а целевой библиотекой можно выбрать kotlinx.serialization или Jackson.

Сделан для момента, когда вы подключаете внешний API в Android-приложении или сервисе на Ktor/Spring и хотите получить каркас модели по одному примеру ответа, а не набирать его вручную. Преобразование целиком выполняется в браузере, так что вставленный ответ внутреннего API никуда не отправляется.

Как пользоваться

  1. Вставьте JSON в поле ввода. Полный реальный ответ даёт более точный вывод типов, чем урезанный.
  2. Укажите в Имя типа имя класса верхнего уровня (по умолчанию Root), например UserResponse.
  3. В Сериализатор выберите kotlinx.serialization или Jackson — то, что уже используется в проекте.
  4. Скопируйте сгенерированный код в файл модели. Имя типа и сериализатор сохраняются в URL, так что закладка откроет ту же настройку.

Пример

Вход (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
Результат (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
)

Объекты внутри массива items становятся классом Item в единственном числе, а gift_wrap, который встречается только во втором элементе, становится Boolean? = null. coupon всегда равен null, так что его тип вывести нельзя, и он остаётся JsonElement? — замените его реальным типом.

Возможности

  • kotlinx.serialization: @Serializable на каждом классе, @SerialName на полях, имя которых изменилось, плюс нужные импорты.
  • Jackson: @JsonProperty только на полях, имя которых изменилось.
  • Ключи вроде user_name или home-url становятся свойствами в camelCase (userName, homeUrl), связанными с исходным ключом через аннотацию.
  • Ключевые слова Kotlin вроде class или val оборачиваются в обратные кавычки; ключи, начинающиеся с цифры, получают префикс n.
  • Числа: целые становятся Int, значения больше 32 бит — Long, а любое дробное делает поле Double.
  • Массивы объектов объединяются в один класс по всем элементам; поля, которые есть лишь в части элементов, становятся ? = null.
  • Массив или примитив верхнего уровня даёт typealias, например typealias Root = List<RootItem>.

Сценарии использования

Модели ответов для клиентов Retrofit или Ktor

Вставьте ответ, скопированный из Postman или DevTools браузера, и получите классы, готовые для Call<Order> или client.get<Order>(). При ответах с десятками полей это избавляет от опечаток и неверных типов при ручном переносе.

Сопоставление API в snake_case с именованием Kotlin

Когда бэкенд присылает created_at, на стороне Kotlin читается createdAt, а serial name хранит исходный ключ. Сопоставление видно в каждом классе, а не зависит от глобальной стратегии именования.

Миграция на kotlinx.serialization

Если вы переводите модели Gson или Jackson на kotlinx.serialization, сгенерируйте оба варианта из одного JSON, чтобы точно увидеть, какие аннотации меняются.

Примечания и ограничения

  • Типы выводятся только по вставленному примеру. Поле, присутствующее во всех элементах примера, выходит non-null, так что для полей, которые по документации API могут отсутствовать, добавьте ? сами.
  • Строки дат вроде 2024-01-01T00:00:00Z остаются String; переход на Instant требует собственного сериализатора.
  • kotlinx.serialization не умеет сериализовать Any, поэтому значения без выводимого типа становятся там JsonElement, а с Jackson — Any.
  • Enum, sealed-классы и значения по умолчанию (вроде пустых списков) не генерируются. Поля с фиксированным набором значений стоит потом превратить в enum.
  • Все классы выводятся одним блоком; объявление пакета и разбиение на файлы — на вас.

Частые вопросы

Почему поле String? = null, а не просто String??

kotlinx.serialization выбрасывает MissingFieldException, когда ключа нет, а у свойства нет значения по умолчанию. Добавление = null к полям, которые отсутствуют в части элементов или содержат null, позволяет ответам без этого ключа нормально декодироваться.

Можно ли оставить ключи JSON именами свойств без @SerialName?

Инструмент всегда переводит в camelCase и добавляет аннотацию только при отличии имени, так что ключи, уже записанные в camelCase, выходят без аннотаций. Чтобы сохранить имена в snake_case, после генерации переименуйте свойства и уберите аннотации.

Нужен ли jackson-module-kotlin при выборе Jackson?

Да. У сгенерированного data class нет конструктора без аргументов, поэтому Jackson нужен зарегистрированный jackson-module-kotlin, чтобы связывать значения через параметры конструктора (Spring Boot регистрирует его автоматически, если зависимость есть).

Может ли он генерировать модели для Moshi или Gson?

Варианты сериализатора — kotlinx.serialization и Jackson. Для Gson возьмите вывод Jackson и замените @JsonProperty на @SerializedName; для Moshi — на @Json(name = ...). Структура классов остаётся той же.