Converta JSON em Codable struct Swift!

Insira JSON para gerar código Codable struct Swift, incluindo objetos aninhados! Compatível com Codable, CodingKeys, JSONDecoder, iOS.
JSON
Resultado
 

Converta JSON em Codable struct Swift!

Converte JSON em structs Swift que adotam Codable. As propriedades são declaradas com let e renomeadas para camelCase, e um enum CodingKeys só é gerado nos structs em que algum nome difere da chave JSON.

Use quando um app iOS ou macOS precisa de um model para decodificar uma resposta do URLSession com JSONDecoder, ou quando você quer tipos que batam com o JSON mock por trás de um preview do SwiftUI.

Como usar

  1. Cole um body de resposta da sua API, por exemplo um capturado com Proxyman ou Charles.
  2. Defina em Nome do tipo o nome do struct de nível mais alto (por exemplo EpisodePage).
  3. Cole o resultado num arquivo Swift; o import Foundation vem incluído.
  4. Decodifique com try JSONDecoder().decode(EpisodePage.self, from: data).

Exemplo

Entrada (JSON)
{
  "podcast": "Swift Talk",
  "episodes": [
    { "id": 301, "title": "Async Sequences", "duration": 1840, "explicit": false },
    { "id": 302, "title": "Macros", "duration": 2215.5, "explicit": false, "guest_name": "Chris" }
  ],
  "total_count": 2
}
Saída (Swift · Codable)
import Foundation

struct EpisodePage: Codable {
    let podcast: String
    let episodes: [Episode]
    let totalCount: Int

    enum CodingKeys: String, CodingKey {
        case podcast
        case episodes
        case totalCount = "total_count"
    }
}

struct Episode: Codable {
    let id: Int
    let title: String
    let duration: Double
    let explicit: Bool
    let guestName: String?

    enum CodingKeys: String, CodingKey {
        case id
        case title
        case duration
        case explicit
        case guestName = "guest_name"
    }
}

Os elementos do array episodes viram um struct Episode. duration mistura um inteiro (1840) e um decimal (2215.5), então é Double; guest_name, encontrado só no segundo episódio, é guestName: String?. Todo struct com um campo renomeado recebe um enum CodingKeys listando todas as suas chaves.

Recursos suportados

  • Todo struct adota Codable; as propriedades são let imutáveis.
  • Chaves snake_case e kebab-case viram propriedades em camelCase, e só nesse caso é adicionado enum CodingKeys: String, CodingKey com as chaves originais.
  • Tipos: String, Int, Double, Bool e [T] para arrays.
  • Campos que faltam em alguns itens ou contêm null são Optionals (String?), então chaves ausentes continuam sendo decodificadas.
  • Valores de tipo misto usam um enum JSONValue gerado e decodificável.
  • Keywords do Swift como default, class ou self são envolvidas em backticks.
  • Um array no nível mais alto gera typealias Root = [RootItem].

Casos de uso

URLSession com async/await

A partir de uma única resposta de exemplo você tem um model que pode decodificar na linha logo depois de let (data, _) = try await URLSession.shared.data(from: url).

Telas de lista no SwiftUI

Adicione Identifiable ao struct gerado (quando ele tem um campo id) e passe direto para List(page.episodes) { ... }.

Dados mock embutidos

Coloque no bundle do app o JSON de exemplo da fase de design e decodifique com o mesmo model, para que as telas possam ser construídas antes de a API real ficar pronta.

Observações e limitações

  • Strings de data saem como String. Para ter Date, mude o tipo da propriedade e defina uma estratégia como decoder.dateDecodingStrategy = .iso8601.
  • Se a chave de uma propriedade não opcional faltar numa resposta, o decode lança DecodingError.keyNotFound. Adicione ? aos campos que a API pode omitir, mesmo que o seu exemplo sempre os tivesse.
  • Todas as propriedades são let; troque para var em models que você altera como state da view.
  • Não são adotados protocolos extras como Identifiable ou Hashable.
  • O enum JSONValue é código auxiliar para tipos mistos; se o seu projeto já tem um tipo equivalente, apague-o e use o seu.

Perguntas frequentes

Com keyDecodingStrategy = .convertFromSnakeCase, posso apagar os CodingKeys?

Sim, o decoder passa a converter guest_name ↔ guestName para você. Só não combine os dois: o decoder converte as chaves para camelCase primeiro e depois as compara com o raw value "guest_name" em CodingKeys, e a correspondência falha.

Por que structs e não classes?

Tratar models de resposta como value types é a convenção usual no Swift, e structs ganham de graça um memberwise initializer, o que facilita montar dados de teste. Se você precisa de semântica de referência, troque para final class e adicione um initializer.

Um campo que eu esperava ser inteiro saiu como Double.

Quando uma chave guarda tanto inteiros quanto decimais, Double evita perda de precisão. Por outro lado, se todos os valores do exemplo forem como 4.0, o parser JSON do navegador os lê como inteiros e você pode receber Int, então confira os valores reais da API.

O encode de volta para JSON mantém as chaves originais?

Os CodingKeys também são usados no encode, então o JSONEncoder escreve guest_name de novo. Propriedades opcionais que estão nil são omitidas da saída.