Convertissez du JSON en Codable struct Swift !

Saisissez du JSON pour générer du code Codable struct Swift, objets imbriqués compris ! Compatible avec Codable, CodingKeys, JSONDecoder, iOS.
JSON
Résultat
 

Convertissez du JSON en Codable struct Swift !

Convertit du JSON en structs Swift conformes à Codable. Les propriétés sont déclarées avec let et renommées en camelCase, et un enum CodingKeys n'est généré que pour les structs où un nom diffère de sa clé JSON.

À utiliser quand une application iOS ou macOS a besoin d'un modèle pour décoder une réponse URLSession avec JSONDecoder, ou quand vous voulez des types correspondant au JSON fictif d'une preview SwiftUI.

Mode d'emploi

  1. Collez un corps de réponse de votre API, par exemple capturé avec Proxyman ou Charles.
  2. Indiquez dans Nom du type le nom de la struct de premier niveau (par exemple EpisodePage).
  3. Collez le résultat dans un fichier Swift ; import Foundation est inclus.
  4. Décodez avec try JSONDecoder().decode(EpisodePage.self, from: data).

Exemple

Entrée (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
}
Sortie (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"
    }
}

Les éléments du tableau episodes deviennent une struct Episode. duration mélange un entier (1840) et un décimal (2215.5) : il est donc Double ; guest_name, présent seulement dans le deuxième épisode, devient guestName: String?. Toute struct comportant un champ renommé reçoit un enum CodingKeys listant toutes ses clés.

Fonctionnalités prises en charge

  • Chaque struct est conforme à Codable ; les propriétés sont des let immuables.
  • Les clés snake_case et kebab-case deviennent des propriétés camelCase, et c'est seulement dans ce cas qu'un enum CodingKeys: String, CodingKey est ajouté avec les clés d'origine.
  • Types : String, Int, Double, Bool, et [T] pour les tableaux.
  • Les champs absents de certains éléments ou contenant null sont des Optionals (String?) : les clés manquantes se décodent quand même.
  • Les valeurs de type mixte utilisent un enum JSONValue généré et décodable.
  • Les mots-clés Swift comme default, class ou self sont entourés de backticks.
  • Un tableau de premier niveau produit typealias Root = [RootItem].

Cas d'utilisation

URLSession avec async/await

À partir d'une seule réponse d'exemple, vous obtenez un modèle à décoder dès la ligne qui suit let (data, _) = try await URLSession.shared.data(from: url).

Écrans de liste SwiftUI

Ajoutez Identifiable à la struct générée (quand elle a un champ id) et passez-la directement à List(page.episodes) { ... }.

Données fictives embarquées

Embarquez dans le bundle de l'application le JSON d'exemple de la phase de design et décodez-le avec le même modèle : les écrans peuvent être construits avant que la vraie API soit prête.

Remarques et limites

  • Les dates au format chaîne restent des String. Pour obtenir Date, changez le type de la propriété et définissez une stratégie comme decoder.dateDecodingStrategy = .iso8601.
  • Si la clé d'une propriété non optionnelle manque dans une réponse, le décodage lève DecodingError.keyNotFound. Ajoutez ? aux champs que l'API peut omettre, même si votre exemple les contenait toujours.
  • Toutes les propriétés sont des let ; passez en var pour les modèles que vous modifiez en tant qu'état de vue.
  • Aucun protocole supplémentaire comme Identifiable ou Hashable n'est adopté.
  • L'enum JSONValue est du code utilitaire pour les types mixtes ; si votre projet a déjà un type équivalent, supprimez-le et utilisez le vôtre.

FAQ

Avec keyDecodingStrategy = .convertFromSnakeCase, puis-je supprimer les CodingKeys ?

Oui, le décodeur convertit alors guest_name ↔ guestName pour vous. Ne combinez cependant pas les deux : le décodeur convertit d'abord les clés en camelCase puis les compare à la raw value "guest_name" des CodingKeys, et la correspondance échoue.

Pourquoi des structs et pas des classes ?

Traiter les modèles de réponse comme des types valeur est la convention Swift habituelle, et les structs reçoivent gratuitement un initialiseur memberwise, ce qui facilite la création de données de test. S'il vous faut une sémantique de référence, passez en final class et ajoutez un initialiseur.

Un champ que j'attendais entier est sorti en Double.

Quand une clé contient à la fois des entiers et des décimaux, Double évite de perdre en précision. À l'inverse, si toutes les valeurs d'exemple ressemblent à 4.0, le parseur JSON du navigateur les lit comme des entiers et vous pouvez obtenir Int : vérifiez les vraies valeurs de l'API.

Le réencodage en JSON conserve-t-il les clés d'origine ?

Les CodingKeys servent aussi à l'encodage : JSONEncoder réécrit donc guest_name. Les propriétés optionnelles valant nil sont omises de la sortie.