JSONをSwiftのCodable structに変換!

JSONを入力すると、ネストしたオブジェクトまでSwiftのCodable structコードに変換します!Codable, CodingKeys, JSONDecoder, iOS 対応。
JSON
結果
 

JSONをSwiftのCodable structに変換!

JSON を、Codable に準拠した Swift の struct に変換します。プロパティは let で宣言して camelCase に名前を変え、名前が JSON のキーと異なる構造体にだけ CodingKeys の enum を生成します。

iOS や macOS のアプリで URLSession のレスポンスを JSONDecoder でデコードするモデルが必要なときや、SwiftUI プレビューの裏にあるモック JSON に合う型がほしいときに使ってください。

使い方

  1. Proxyman や Charles でキャプチャしたものなど、API のレスポンスボディを貼り付けます。
  2. 型名 にトップレベルの構造体名を設定します(例: EpisodePage)。
  3. 結果を Swift ファイルに貼り付けます。import Foundation も含まれています。
  4. try JSONDecoder().decode(EpisodePage.self, from: data) でデコードします。

例

入力 (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
}
出力 (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"
    }
}

episodes 配列の要素は Episode 構造体になります。duration は整数(1840)と小数(2215.5)が混ざっているので Double に、2つ目のエピソードにしかない guest_name は guestName: String? になります。名前を変えたフィールドを持つ構造体には、すべてのキーを並べた CodingKeys の enum が付きます。

対応機能

  • すべての構造体が Codable に準拠し、プロパティはイミュータブルな let です。
  • snake_case や kebab-case のキーは camelCase のプロパティになり、その場合にだけ元のキーを持つ enum CodingKeys: String, CodingKey が追加されます。
  • 型: String、Int、Double、Bool、配列は [T]。
  • 一部の要素にないフィールドや null を含むフィールドは Optional(String?)になるので、キーが欠けていてもデコードできます。
  • 型が混在する値には、生成されるデコード可能な JSONValue の enum を使います。
  • default、class、self のような Swift のキーワードはバッククォートで囲みます。
  • トップレベルが配列のときは typealias Root = [RootItem] を出力します。

利用シーン

async/await での URLSession

サンプルレスポンス1つから、let (data, _) = try await URLSession.shared.data(from: url) の次の行ですぐにデコードできるモデルが得られます。

SwiftUI のリスト画面

生成された構造体に(id フィールドがあれば)Identifiable を追加し、そのまま List(page.episodes) { ... } に渡せます。

アプリに同梱するモックデータ

デザイン段階のサンプル JSON をアプリバンドルに入れて同じモデルでデコードすれば、本物の API ができる前から画面を作れます。

注意点と制限

  • 日付の文字列は String で出力されます。Date にするには、プロパティの型を変えて decoder.dateDecodingStrategy = .iso8601 のような戦略を設定してください。
  • Optional でないプロパティのキーがレスポンスにないと、デコードは DecodingError.keyNotFound を投げます。サンプルに常にあったとしても、API が省略しうるフィールドには ? を付けてください。
  • プロパティはすべて let です。ビューの状態として変更するモデルは var に切り替えてください。
  • Identifiable や Hashable のような追加のプロトコルには準拠させません。
  • JSONValue の enum は型が混在する値のための補助コードです。プロジェクトに同等の型がすでにあるなら、削除してそちらを使ってください。

よくある質問

keyDecodingStrategy = .convertFromSnakeCase を使えば、CodingKeys を削除できますか?

できます。その場合はデコーダーが guest_name ↔ guestName を変換してくれます。ただし両方を併用しないでください。デコーダーはまずキーを camelCase に変換してから CodingKeys の "guest_name" という raw value と比べるので、一致しなくなります。

クラスではなく構造体なのはなぜですか?

レスポンスのモデルを値型として扱うのが Swift の一般的な慣習で、構造体にはメンバーワイズイニシャライザーが自動で付くため、テストデータも作りやすくなります。参照セマンティクスが必要なら final class に変えてイニシャライザーを追加してください。

整数だと思っていたフィールドが Double になりました。

1つのキーに整数と小数の両方がある場合、精度を失わないよう Double にします。逆に、サンプルの値がすべて 4.0 のような形だと、ブラウザーの JSON パーサーが整数として読むため Int になることがあるので、実際の API の値を確認してください。

JSON にエンコードし直したとき、元のキーは保たれますか?

CodingKeys はエンコードにも使われるので、JSONEncoder は再び guest_name と書き出します。nil の Optional プロパティは出力から省かれます。