Вставьте существующий data class на Kotlin и посмотрите, как он выглядит после сериализации, в виде примера JSON-документа. Вложенные классы, свойства List/Map и enum отслеживаются и заполняются, а аннотации переименования вроде @SerialName применяются к ключам.
Пригодится, когда сервер и приложение используют общие модели и нужно убедиться, какой JSON класс на самом деле отправляет и принимает, или когда для документации API или mock-сервера нужен пример тела запроса.
import/package и функции-члены можно оставить — они пропускаются.Корневой тип в положении Автоматически: корнем становится первый класс, на который не ссылается другой класс. Можно также выбрать конкретный класс из списка.Money из другого файла), выводятся как null, а их имена перечисляются рядом с опциями. Вставьте и эти классы — и они будут заполнены.@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,
}{
"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-значением этого элемента.@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 или пустом массиве, а не разворачиваются бесконечно.Вставьте DTO ответа — и у вас готов каркас JSON для example в OpenAPI или README. Поля, переименованные через @SerialName, показаны под тем же именем, которое на самом деле запишет сериализатор.
Соберите тело для MockWebServer или локальной JSON-фикстуры из той самой модели, которую возвращает ваш интерфейс Retrofit. Замените значения-заглушки ("", 0) реалистичными данными — структура по-прежнему будет совпадать с моделью.
Покажите серверной команде, что именно отправляет приложение, или сравните полученную спецификацию со своей моделью на Kotlin, чтобы поймать расхождения в именах ключей до того, как они станут ошибками во время выполнения.
"", 0, false), а не реалистичные данные; замените их перед публикацией документации.String?) тоже получают типизированный пример, а не null, так что отдельно пометьте, какие поля действительно могут быть null.@JsonNaming в Jackson или JsonNamingStrategy в kotlinx не применяются; свойства без аннотаций сохраняют имя из Kotlin как ключ.type) и пользовательские KSerializer не отражаются.emptyList() или listOf(...), не вычисляются; значение берётся из объявленного типа.@Transient нет в выводе. Так и должно быть?Да. @Transient из kotlinx.serialization и @JsonIgnore из Jackson исключают поле из сериализации, поэтому пример его тоже опускает. private val, объявленный в теле класса, не выводится по той же причине.
Синтаксис классов тот же, так что они разбираются нормально. Переименования через @SerializedName("...") из Gson и @Json(name = "...") из Moshi распознаются.
= null, почему у поля есть значение?Цель — показать форму каждого поля, поэтому значение по умолчанию null игнорируется и используется типизированный пример. Так видно, например, в каком строковом формате передаётся Instant?.
Вставьте их друг за другом в одно поле ввода. Каждый всё ещё недостающий тип называется рядом с опциями — так понятно, что ещё добавить.