Pega una data class de Kotlin existente y mira cómo queda una vez serializada, como documento JSON de ejemplo. Se siguen y se rellenan las clases anidadas, las propiedades List/Map y los enums, y las anotaciones de renombrado como @SerialName se aplican a las claves.
Recurre a ella cuando un servidor y una app comparten modelos y necesitas confirmar qué JSON envía y recibe realmente una clase, o cuando una documentación de API o un servidor mock necesitan un ejemplo de body de petición.
import/package y las funciones miembro pueden quedarse; se omiten.Tipo raíz en Automático: la primera clase que ninguna otra referencia pasa a ser la raíz. También puedes elegir una clase concreta de la lista.Money de otro archivo) salen como null, y sus nombres se listan junto a las opciones. Pega también esas clases y se rellenarán.@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 se emite como author_name por @SerialName, y el valor por defecto PostStatus.DRAFT se resuelve a "draft" gracias al @SerialName de la propia entrada del enum. cachedHtml está marcado con @Transient, así que se descarta. Una propiedad nullable cuyo valor por defecto es null, como publishedAt, recibe igualmente un ejemplo tipado (Instant → timestamp ISO) en lugar de null.
@SerialName de kotlinx.serialization, @JsonProperty de Jackson, @SerializedName de Gson y @Json(name = ...) de Moshi.@Transient o @JsonIgnore, las propiedades private, las delegadas como by lazy, las propiedades calculadas con solo getter, los valores const y los miembros de companion object.Status.PAID pasa a ser el valor JSON de esa entrada.@SerialName a nivel de entrada.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → cadena ISO terminada en Z, Duration → PT0S; UUID recibe un valor con el formato correcto.List, Set y Array reciben un elemento de ejemplo; un map con tipo de clave numérico como Map<Int, V> usa "0" como clave.null o un array vacío en lugar de expandirse sin fin.Pega un DTO de respuesta y tendrás el esqueleto JSON para un example de OpenAPI o un README. Los campos renombrados mediante @SerialName aparecen con el mismo nombre que escribirá realmente el serializer.
Construye el body para MockWebServer o un fixture JSON local a partir del mismo modelo que devuelve tu interfaz de Retrofit. Cambia los valores placeholder ("", 0) por datos realistas y la estructura seguirá coincidiendo con el modelo.
Muestra al equipo del servidor exactamente lo que envía la app, o compara una especificación recibida con tu modelo Kotlin para detectar diferencias en los nombres de las claves antes de que se conviertan en errores en runtime.
"", 0, false), no datos realistas; sustitúyelos antes de publicar la documentación.String?) también reciben un ejemplo tipado en lugar de null, así que indica aparte qué campos pueden ser realmente null.@JsonNaming de Jackson o JsonNamingStrategy de kotlinx; las propiedades sin anotación usan su nombre en Kotlin como clave.type) ni los KSerializer personalizados.emptyList() o listOf(...), no se evalúan; el valor sale del tipo declarado.@Transient no aparece en la salida. ¿Es lo esperado?Sí. @Transient de kotlinx.serialization y @JsonIgnore de Jackson dejan un campo fuera de la serialización, así que el ejemplo también lo omite. Un private val declarado en el cuerpo de la clase queda fuera por el mismo motivo.
La sintaxis de las clases es la misma, así que se parsean bien. Se reconocen los renombrados de @SerializedName("...") de Gson y @Json(name = "...") de Moshi.
= null, ¿por qué el campo tiene un valor?El objetivo es mostrar la forma de cada campo, así que un valor por defecto null se ignora y se usa un ejemplo tipado. Así puedes ver, por ejemplo, en qué formato de cadena viaja un Instant?.
Pégalas una tras otra en la misma entrada. Cualquier tipo que siga faltando aparece nombrado junto a las opciones, lo que te indica qué más añadir.