JSON in Swift-Codable struct umwandeln!

Gib JSON ein, um Swift-Codable struct-Code inklusive verschachtelter Objekte zu erzeugen! Unterstützt Codable, CodingKeys, JSONDecoder, iOS.
JSON
Ergebnis
 

JSON in Swift-Codable struct umwandeln!

Wandle JSON in Swift-structs um, die Codable übernehmen. Properties werden mit let deklariert und in camelCase umbenannt, und ein CodingKeys-Enum wird nur für Structs erzeugt, in denen ein Name von seinem JSON-Key abweicht.

Verwende es, wenn eine iOS- oder macOS-App ein Modell braucht, um eine URLSession-Antwort mit JSONDecoder zu dekodieren, oder wenn du Typen passend zum Mock-JSON hinter einer SwiftUI-Preview willst.

So funktioniert es

  1. Füge einen Response-Body deiner API ein, zum Beispiel einen, den du mit Proxyman oder Charles mitgeschnitten hast.
  2. Setze Typname auf den Namen des obersten Structs (zum Beispiel EpisodePage).
  3. Füge das Ergebnis in eine Swift-Datei ein; import Foundation ist enthalten.
  4. Dekodiere mit try JSONDecoder().decode(EpisodePage.self, from: data).

Beispiel

Eingabe (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
}
Ausgabe (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"
    }
}

Die Elemente des Arrays episodes werden zu einem Struct Episode. duration mischt eine Ganzzahl (1840) und eine Dezimalzahl (2215.5) und ist daher Double; guest_name, das nur in der zweiten Episode vorkommt, ist guestName: String?. Jedes Struct mit einem umbenannten Feld bekommt ein CodingKeys-Enum, das alle seine Keys aufführt.

Unterstützte Funktionen

  • Jedes Struct übernimmt Codable; Properties sind unveränderliche lets.
  • Keys in snake_case und kebab-case werden zu camelCase-Properties, und nur dann wird enum CodingKeys: String, CodingKey mit den ursprünglichen Keys ergänzt.
  • Typen: String, Int, Double, Bool und [T] für Arrays.
  • Felder, die in manchen Elementen fehlen oder null enthalten, sind Optionals (String?), sodass fehlende Keys trotzdem dekodiert werden.
  • Werte mit gemischtem Typ verwenden ein erzeugtes, dekodierbares Enum JSONValue.
  • Swift-Schlüsselwörter wie default, class oder self werden in Backticks gesetzt.
  • Ein Array auf oberster Ebene erzeugt typealias Root = [RootItem].

Anwendungsfälle

URLSession mit async/await

Aus einer einzigen Beispielantwort bekommst du ein Modell, das du direkt in der Zeile nach let (data, _) = try await URLSession.shared.data(from: url) dekodieren kannst.

Listen-Screens in SwiftUI

Ergänze Identifiable am erzeugten Struct (wenn es ein Feld id hat) und übergib es direkt an List(page.episodes) { ... }.

Mitgelieferte Mock-Daten

Liefere das Beispiel-JSON aus der Designphase im App-Bundle mit und dekodiere es mit demselben Modell, damit sich Screens bauen lassen, bevor die echte API fertig ist.

Hinweise und Einschränkungen

  • Datums-Strings werden als String ausgegeben. Für Date änderst du den Property-Typ und setzt eine Strategie wie decoder.dateDecodingStrategy = .iso8601.
  • Fehlt in einer Antwort der Key einer nicht optionalen Property, wirft das Dekodieren DecodingError.keyNotFound. Ergänze ? an Feldern, die die API weglassen darf, auch wenn dein Beispiel sie immer hatte.
  • Alle Properties sind let; stelle bei Modellen, die du als View-State veränderst, auf var um.
  • Zusätzliche Protokolle wie Identifiable oder Hashable werden nicht übernommen.
  • Das Enum JSONValue ist Hilfscode für gemischte Typen; hat dein Projekt bereits einen gleichwertigen Typ, lösche es und verwende deinen.

Häufige Fragen

Kann ich mit keyDecodingStrategy = .convertFromSnakeCase die CodingKeys löschen?

Ja, dann wandelt der Decoder guest_name ↔ guestName für dich um. Kombiniere aber nicht beides: Der Decoder wandelt die Keys zuerst in camelCase um und vergleicht sie dann mit dem Raw Value "guest_name" in CodingKeys, sodass der Abgleich fehlschlägt.

Warum Structs und keine Klassen?

Response-Modelle als Werttypen zu behandeln ist die übliche Swift-Konvention, und Structs bekommen kostenlos einen Memberwise-Initializer, was das Erstellen von Testdaten erleichtert. Brauchst du Referenzsemantik, wechsle zu final class und ergänze einen Initializer.

Ein Feld, das ich als Ganzzahl erwartet habe, kam als Double heraus.

Enthält ein Key sowohl Ganzzahlen als auch Dezimalzahlen, vermeidet Double Genauigkeitsverluste. Umgekehrt liest der JSON-Parser des Browsers Werte wie 4.0 als Ganzzahl, wenn alle Beispielwerte so aussehen, und du bekommst womöglich Int; prüfe also echte API-Werte.

Bleiben beim Zurückkodieren in JSON die ursprünglichen Keys erhalten?

CodingKeys werden auch beim Kodieren verwendet, JSONEncoder schreibt also wieder guest_name. Optionale Properties, die nil sind, werden in der Ausgabe weggelassen.