Converta JSON em data class Kotlin!

Insira JSON para gerar código data class Kotlin, incluindo objetos aninhados! Compatível com kotlinx.serialization @Serializable, @SerialName, Jackson.
JSON
Resultado
 

Converta JSON em data class Kotlin!

Cole uma resposta de API ou um JSON de configuração e receba código Kotlin com data class que espelha a estrutura dele. Objetos aninhados e arrays de objetos viram cada um a sua própria classe, e você pode gerar para kotlinx.serialization ou para Jackson.

Foi feito para o momento em que você integra uma API externa num app Android ou num serviço Ktor/Spring e quer o esqueleto do model a partir de uma única resposta de exemplo, em vez de digitar tudo. A conversão roda inteira no navegador, então colar uma resposta de API interna não a envia para lugar nenhum.

Como usar

  1. Cole o JSON na caixa de entrada. Uma resposta real completa dá uma inferência de tipos melhor do que uma resumida.
  2. Defina em Nome do tipo o nome da classe de nível mais alto (padrão Root), por exemplo UserResponse.
  3. Escolha kotlinx.serialization ou Jackson em Serializador, de acordo com o que o seu projeto já usa.
  4. Copie o código gerado para o seu arquivo de model. O nome do tipo e o serializador ficam na URL, então um favorito reabre a mesma configuração.

Exemplo

Entrada (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
Saída (Kotlin · kotlinx.serialization)
import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement

@Serializable
data class Order(
    val orderId: String,
    val paid: Boolean,
    val total: Double,
    val coupon: JsonElement? = null,
    val items: List<Item>
)

@Serializable
data class Item(
    val sku: String,
    val qty: Int,
    @SerialName("gift_wrap") val giftWrap: Boolean? = null
)

Os objetos dentro do array items viram uma classe Item no singular, e gift_wrap, que só aparece no segundo item, vira Boolean? = null. coupon só aparece como null, então o tipo não pode ser inferido e fica como JsonElement? para você trocar pelo tipo real.

Recursos suportados

  • kotlinx.serialization: @Serializable em todas as classes, @SerialName nos campos cujo nome mudou, mais os imports necessários.
  • Jackson: @JsonProperty só nos campos cujo nome mudou.
  • Chaves como user_name ou home-url viram propriedades em camelCase (userName, homeUrl) mapeadas de volta para a chave original por anotação.
  • Keywords do Kotlin como class ou val são envolvidas em backticks; chaves que começam com dígito ganham o prefixo n.
  • Números: inteiros viram Int, valores acima de 32 bits viram Long, e qualquer decimal transforma o campo em Double.
  • Arrays de objetos são mesclados numa só classe a partir de todos os itens; campos presentes só em alguns itens viram ? = null.
  • Um array ou primitivo no nível mais alto gera um typealias, por exemplo typealias Root = List<RootItem>.

Casos de uso

Models de resposta para clients Retrofit ou Ktor

Cole uma resposta copiada do Postman ou do DevTools do navegador e você recebe classes prontas para Call<Order> ou client.get<Order>(). Com respostas de dezenas de campos, isso evita erros de digitação e tipos errados de quem copia à mão.

Mapear uma API snake_case para a nomenclatura Kotlin

Quando o backend manda created_at, o lado Kotlin lê createdAt enquanto o serial name guarda a chave original. O mapeamento fica visível em cada classe, em vez de depender de uma naming strategy global.

Migrar para kotlinx.serialization

Se você está passando models do Gson ou do Jackson para kotlinx.serialization, gere as duas saídas a partir do mesmo JSON para ver exatamente quais anotações mudam.

Observações e limitações

  • Os tipos são inferidos só a partir do exemplo que você cola. Um campo presente em todos os itens do exemplo sai non-null, então adicione ? você mesmo nos campos que a documentação da API diz que podem ser omitidos.
  • Strings de data como 2024-01-01T00:00:00Z continuam String; trocar para Instant exige um serializer próprio.
  • O kotlinx.serialization não consegue serializar Any, então valores sem tipo inferível viram JsonElement nele e Any com Jackson.
  • Não são gerados enums, sealed classes nem valores padrão (como listas vazias). Campos com um conjunto fixo de valores valem a pena virar enum depois.
  • Todas as classes saem num bloco só; declaração de package e divisão em arquivos ficam por sua conta.

Perguntas frequentes

Por que um campo é String? = null e não só String??

O kotlinx.serialization lança MissingFieldException quando uma chave falta e a propriedade não tem default. Adicionar = null aos campos que faltam em alguns itens ou contêm null faz respostas sem essa chave serem decodificadas sem erro.

Posso manter as chaves JSON como nomes de propriedade sem @SerialName?

A ferramenta sempre converte para camelCase e só adiciona anotação quando o nome muda, então chaves que já estão em camelCase saem sem anotação. Para manter nomes snake_case, renomeie as propriedades e tire as anotações depois de gerar.

Preciso do jackson-module-kotlin ao escolher Jackson?

Sim. A data class gerada não tem construtor sem argumentos, então o Jackson precisa do jackson-module-kotlin registrado para fazer bind dos valores pelos parâmetros do construtor (o Spring Boot registra automaticamente quando a dependência está presente).

Ele gera models para Moshi ou Gson?

As opções de serializador são kotlinx.serialization e Jackson. Para Gson, pegue a saída do Jackson e troque @JsonProperty por @SerializedName; para Moshi, use @Json(name = ...). A estrutura das classes continua a mesma.