Конвертировать JSON в классы данных Kotlin — Numio

Когда пригодится

• Описать REST-ответ для Android-приложения, которое разбирает JSON через Jackson.
• Создать DTO для сервиса на Ktor или Spring Boot по примеру payload.

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

1. Вставьте репрезентативный JSON-объект или массив в редактор JSON; добавьте элементы массива, в которых видны необязательные ключи.
2. Изучите панель Kotlin: класс верхнего уровня называется Root, а вложенные классы получают имена по своим ключам (projects становится Project).
3. Скопируйте классы, переименуйте Root и замените Any? или Long там, где контракт вашего API требует иного.

{
  "id": 1024,
  "full_name": "Ada Lovelace",
  "email": null,
  "roles": ["admin", "editor"],
  "projects": [
    { "name": "Engine", "stars": 42 },
    { "name": "Notes", "stars": 7, "archived": true }
  ]
}

import com.fasterxml.jackson.annotation.JsonProperty

data class Root(
    val id: Long,
    @JsonProperty("full_name")
    val fullName: String,
    val email: Any?,
    val roles: List<String>,
    val projects: List<Project>,
)

data class Project(
    val name: String,
    val stars: Long,
    val archived: Boolean?,
)

Подробности и ограничения

Преобразование выполняется в браузере WebAssembly-модулем json_typegen; JSON никуда не загружается. Настроек на этой странице нет.

Ключи не в camelCase получают аннотацию Jackson @JsonProperty и импорт com.fasterxml.jackson.annotation.JsonProperty. Аннотации kotlinx.serialization или Moshi не генерируются.

Значения null и пустые массивы не несут информации о типе, поэтому становятся Any? и List<Any?>.

У nullable-полей нет значения по умолчанию (= null). Добавьте его сами, если поле может отсутствовать при десериализации.

FAQ

Похожие инструменты

Спецификации и справка

• Kotlin docs: Data classes