Преобразуйте классы Kotlin в JSON!

Вставьте код Kotlin (data class) и получите пример JSON! Поддержка: kotlinx.serialization @SerialName, Jackson, Gson, Moshi. Удобно для документации API и тестовых тел запросов (mock request body).
Kotlin
Результат
 

Преобразуйте классы Kotlin в JSON!

Вставьте существующий data class на Kotlin и посмотрите, как он выглядит после сериализации, в виде примера JSON-документа. Вложенные классы, свойства List/Map и enum отслеживаются и заполняются, а аннотации переименования вроде @SerialName применяются к ключам.

Пригодится, когда сервер и приложение используют общие модели и нужно убедиться, какой JSON класс на самом деле отправляет и принимает, или когда для документации API или mock-сервера нужен пример тела запроса.

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

  1. Вставьте исходный код на Kotlin. Строки import/package и функции-члены можно оставить — они пропускаются.
  2. В большинстве случаев оставьте Корневой тип в положении Автоматически: корнем становится первый класс, на который не ссылается другой класс. Можно также выбрать конкретный класс из списка.
  3. Скопируйте JSON в пример Swagger, тело запроса в Postman или тестовую фикстуру.
  4. Типы, определённые в другом месте (скажем, класс Money из другого файла), выводятся как null, а их имена перечисляются рядом с опциями. Вставьте и эти классы — и они будут заполнены.

Пример

Вход (Kotlin)
@Serializable
data class Article(
    val id: Long,
    val title: String,
    @SerialName("author_name") val authorName: String,
    val status: PostStatus = PostStatus.DRAFT,
    val tags: List<String> = emptyList(),
    val publishedAt: Instant? = null,
    @Transient val cachedHtml: String = "",
)

@Serializable
enum class PostStatus {
    @SerialName("draft") DRAFT,
    @SerialName("published") PUBLISHED,
}
Результат (JSON)
{
  "id": 0,
  "title": "",
  "author_name": "",
  "status": "draft",
  "tags": [
    ""
  ],
  "publishedAt": "1970-01-01T00:00:00Z"
}

authorName выводится как author_name благодаря @SerialName, а значение по умолчанию PostStatus.DRAFT превращается в "draft" через собственный @SerialName элемента enum. cachedHtml помечен @Transient, поэтому отброшен. Nullable-свойство со значением по умолчанию null, как publishedAt, всё равно получает типизированный пример (Instant → метка времени ISO), а не null.

Возможности

  • Переименование ключей: @SerialName из kotlinx.serialization, @JsonProperty из Jackson, @SerializedName из Gson и @Json(name = ...) из Moshi.
  • Исключаются: свойства с @Transient или @JsonIgnore, private-свойства, делегированные вроде by lazy, вычисляемые свойства только с геттером, значения const и члены companion object.
  • Литеральные значения по умолчанию — строки, числа и булевы — используются как значение примера; значение по умолчанию вроде Status.PAID становится JSON-значением этого элемента.
  • Enum используют свой первый элемент с учётом @SerialName на уровне элемента.
  • Даты и время: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → ISO-строка с Z на конце, Duration → PT0S; UUID получает корректно сформированное значение.
  • List, Set и Array получают один элемент-пример; map с числовым типом ключа вроде Map<Int, V> использует ключ "0".
  • Самоссылающиеся классы (деревья, ветки комментариев) обрываются на null или пустом массиве, а не разворачиваются бесконечно.

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

Документация API для сервисов на Ktor или Spring

Вставьте DTO ответа — и у вас готов каркас JSON для example в OpenAPI или README. Поля, переименованные через @SerialName, показаны под тем же именем, которое на самом деле запишет сериализатор.

Фейковые ответы для Android-тестов

Соберите тело для MockWebServer или локальной JSON-фикстуры из той самой модели, которую возвращает ваш интерфейс Retrofit. Замените значения-заглушки ("", 0) реалистичными данными — структура по-прежнему будет совпадать с моделью.

Согласование имён ключей с бэкендом

Покажите серверной команде, что именно отправляет приложение, или сравните полученную спецификацию со своей моделью на Kotlin, чтобы поймать расхождения в именах ключей до того, как они станут ошибками во время выполнения.

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

  • Значения — заглушки по типу ("", 0, false), а не реалистичные данные; замените их перед публикацией документации.
  • Nullable-свойства (String?) тоже получают типизированный пример, а не null, так что отдельно пометьте, какие поля действительно могут быть null.
  • Глобальные правила именования вроде @JsonNaming в Jackson или JsonNamingStrategy в kotlinx не применяются; свойства без аннотаций сохраняют имя из Kotlin как ключ.
  • Полиморфные sealed-иерархии (дискриминатор type) и пользовательские KSerializer не отражаются.
  • Значения по умолчанию из вызовов функций, вроде emptyList() или listOf(...), не вычисляются; значение берётся из объявленного типа.

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

Свойства с @Transient нет в выводе. Так и должно быть?

Да. @Transient из kotlinx.serialization и @JsonIgnore из Jackson исключают поле из сериализации, поэтому пример его тоже опускает. private val, объявленный в теле класса, не выводится по той же причине.

Читает ли он модели, написанные для Gson или Moshi?

Синтаксис классов тот же, так что они разбираются нормально. Переименования через @SerializedName("...") из Gson и @Json(name = "...") из Moshi распознаются.

Я объявил = null, почему у поля есть значение?

Цель — показать форму каждого поля, поэтому значение по умолчанию null игнорируется и используется типизированный пример. Так видно, например, в каком строковом формате передаётся Instant?.

Мои классы лежат в нескольких файлах. Что вставлять?

Вставьте их друг за другом в одно поле ввода. Каждый всё ещё недостающий тип называется рядом с опциями — так понятно, что ещё добавить.