JSON→Swift変換

JSONサンプルからSwiftの型を組み立てる

JSON→Swift変換は、貼り付けたJSONを読み取り、含まれる値や入れ子構造に沿ったSwiftの型コードを作るツールです。文字列、真偽値、数値、配列、オブジェクトなどの形をサンプルから推定します。たとえば、{"user":{"name":"Aki","active":true}}なら、ユーザー情報を表す型と、その中の文字列・真偽値プロパティが出力候補になります。

ここで得られるのは、入力サンプルに基づくモデルのたたき台です。API仕様書やJSON Schemaを読み込んで検証するものではなく、将来の応答や未提示の項目まで保証しません。生成された型名やプロパティ、オプションを確認し、実際のレスポンス仕様に合わせて利用してください。

SwiftのCodableは、型をJSONとのエンコード・デコードに対応させる仕組みです。このツールでは「型定義のみ」が初期状態のため、初期出力にCodable適合が含まれるとは限りません。完全な生成コードが必要な場合は設定で型定義のみをオフにし、出力された適合やCodingKeysを確認します。Appleの説明では、CodingKeysを使ってプロパティ名とJSONキーの対応を定義できます。AppleのCodable解説も参照してください。

入力からコードを持ち出すまで

1. 有効なJSONを用意する

   JSONオブジェクトまたは配列を入力欄に貼り付けます。コメント、末尾のカンマ、JavaScript独自の値を含まない標準的なJSONを使ってください。形式を整えたい場合はフォーマット操作を利用できます。

2. 型名と出力形式を決める

   初期の型名はRootです。用途が分かる名前に変更できます。Swiftでは構造体またはクラスを選択でき、「型定義のみ」を切り替えられます。完全な定義を出す場合は、初期化子やCodingKeysの設定も確認します。

3. 推論オプションを見直す

   日時、UUID、列挙型、マップなどの推論設定があります。サンプル文字列が常に日付形式であるとは限らないため、特定の型に推論された項目は元データの仕様と照合します。

4. 生成コードを確認して利用する

   入力変更後に結果が生成されます。エラーが出た場合はJSON構文を修正してください。コードをコピーするかダウンロードし、プロジェクトに追加した後、実レスポンスを使ってコンパイルとデコードを確認します。

JSONの構文上の基準はRFC 8259で確認できます。

生成結果を読むときの疑問

サンプルで見えない条件は別途確認する

型生成の結果は入力例の形を反映した草案です。実運用での互換性は、APIの正式な仕様と実データによる確認で判断してください。

• フィールドがサンプルに存在しても、すべての応答で必須とは限りません。欠落やnullの可能性を確認し、必要ならOptionalなどに修正します。
• 空配列では要素の型を判断できず、整数と小数が混在する値や、同じ項目に複数形式がある値も期待と異なる型になることがあります。
• 日付らしい文字列やUUIDらしい文字列が、業務上も常にその形式であるとは限りません。推論結果を元データの契約と照合してください。
• 出力されたコードはプロジェクトのSwiftバージョン、命名規則、アクセス制御やデコード要件に合わせた調整が必要です。生成だけでコンパイルや本番応答への適合が保証されるわけではありません。