@SerialName e mapeamento personalizado de campos

As APIs reais adoram chaves como user_name, mas o Kotlin prefere userName. @SerialName permite que os dois sejam diferentes sem conflitos.

Coloque @SerialName acima de uma propriedade para informar ao serializador a qual chave JSON ela realmente corresponde.

Seu código mantém nomes limpos em camelCase, enquanto o formato de transmissão conserva o que o back-end escolheu. Todos ganham.

Muitas APIs JSON usam snake_case, por isso mapear created_at para uma propriedade createdAt é uma das utilizações mais comuns.

Se o JSON tiver uma chave como type que entre em conflito com o seu estilo, @SerialName permite dar à propriedade o nome que ficar mais claro.

Você pode anotar quantas propriedades quiser, misturando campos renomeados e campos com nomes padrão na mesma classe de dados.

@SerialName também funciona em constantes de enumeração, portanto uma entrada ACTIVE pode ser serializada como a string em minúsculas que a API espera.

Se todas as chaves estiverem em snake_case, você poderá definir uma JsonNamingStrategy uma única vez, em vez de anotar cada campo manualmente.

Quando uma estratégia global e um @SerialName explícito se aplicam, a anotação tem prioridade para esse campo.

Os nomes personalizados se aplicam tanto à codificação quanto à decodificação, portanto um único modelo anotado lida com a leitura e a escrita de JSON.

Mapear as chaves explicitamente significa que uma renomeação no back-end altera apenas uma anotação, e não toda a sua base de código.

Use @SerialName para mapear chaves JSON com nomes diferentes para nomes idiomáticos do Kotlin em campos e enumerações, ou defina uma estratégia de nomes global para modelos inteiros.