Cole uma data class Kotlin existente e veja como ela fica depois de serializada, num JSON de exemplo. Classes aninhadas, propriedades List/Map e enums são seguidos e preenchidos, e anotações de renomeação como @SerialName são aplicadas às chaves.
Use quando servidor e app compartilham models e você precisa confirmar qual JSON uma classe realmente manda e recebe, ou quando uma documentação de API ou um servidor mock precisa de um exemplo de request body.
import/package e funções membro podem ficar; elas são puladas.Tipo raiz em Automático: a primeira classe que não é referenciada por outra vira a raiz. Você também pode escolher uma classe específica na lista.Money de outro arquivo) saem como null, e os nomes deles aparecem listados ao lado das opções. Cole essas classes também e elas são preenchidas.@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 é emitido como author_name por causa do @SerialName, e o default PostStatus.DRAFT resolve para "draft" pelo @SerialName da própria entrada do enum. cachedHtml está marcado com @Transient, então é descartado. Uma propriedade nullable com default null, como publishedAt, ainda recebe um exemplo do tipo (Instant → timestamp ISO) em vez de null.
@SerialName do kotlinx.serialization, @JsonProperty do Jackson, @SerializedName do Gson e @Json(name = ...) do Moshi.@Transient ou @JsonIgnore, propriedades private, delegadas como by lazy, propriedades calculadas só com getter, valores const e membros de companion object.Status.PAID vira o valor JSON dessa entrada.@SerialName no nível da entrada.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → string ISO terminando em Z, Duration → PT0S; UUID recebe um valor bem formado.List, Set e Array recebem um elemento de exemplo; um map com tipo de chave numérico, como Map<Int, V>, usa "0" como chave.null ou um array vazio em vez de se expandirem para sempre.Cole um DTO de resposta e você tem o esqueleto JSON para um example do OpenAPI ou um README. Campos renomeados via @SerialName aparecem com o mesmo nome que o serializer vai realmente escrever.
Monte o body para o MockWebServer ou uma fixture JSON local a partir do próprio model que a sua interface Retrofit retorna. Troque os valores placeholder ("", 0) por dados realistas e a estrutura continua batendo com o model.
Mostre ao time do servidor exatamente o que o app manda, ou compare uma especificação recebida com o seu model Kotlin para pegar diferenças nos nomes das chaves antes que virem erros em runtime.
"", 0, false), não dados realistas; troque antes de publicar a documentação.String?) também recebem um exemplo do tipo em vez de null, então indique à parte quais campos podem de fato ser null.@JsonNaming do Jackson ou o JsonNamingStrategy do kotlinx, não são aplicadas; propriedades sem anotação mantêm o nome Kotlin como chave.type) e KSerializers customizados não são refletidos.emptyList() ou listOf(...), não são avaliados; o valor vem do tipo declarado.@Transient não aparece na saída. Isso é esperado?Sim. O @Transient do kotlinx.serialization e o @JsonIgnore do Jackson deixam um campo fora da serialização, então o exemplo também o omite. Um private val declarado no corpo da classe fica de fora pelo mesmo motivo.
A sintaxe das classes é a mesma, então o parse funciona. As renomeações de @SerializedName("...") do Gson e de @Json(name = "...") do Moshi são reconhecidas.
= null, então por que o campo tem valor?O objetivo é mostrar o formato de cada campo, então um default null é ignorado e é usado um exemplo do tipo. Assim você vê, por exemplo, em qual formato de string um Instant? trafega.
Cole uma depois da outra na mesma entrada. Qualquer tipo que ainda falte aparece nomeado ao lado das opções, o que indica o que mais adicionar.