SwiftのCodableでJSONデコード時、特定の項目が場合によって型が異なるため、どちらにも対応させたい。

Question

前提・実現したいこと

今週からSwiftでアプリ開発をはじめたsharmanと言います。
APIからJson形式でデータを取得するのですが、そのAPIの処理結果がOKの時と、NGの時とで特定の項目のみ、オブジェクトか文字列かで型が異なります。

OK：オブジェクトが返ってくるため、それに合わせたクラスの型
NG：空文字

OKの時↓

{"result": {
          "message": "",
　　　　　　"response": {
                        "data":[{
                                  "xxx": "xxx",
                                  "yyy": "yyy"
                                 }]
                      },
           "status": "OK"
           }
}

NGの時↓

{"result": {
           "message": "エラーメッセージ",
　　　　　　 "response": "",
           "status": "NG"
           }
}

responseが、APIの結果がOKの時は処理結果の情報をオブジェクトで返し、NGの時は空文字を入れてきます。

受け取り側では、

struct Response: Codable {
        let result: Result

        struct Result: Codable {
             let message: String
             let response: Response
             let status: String
       
             struct Response: Codable {
                let xxx: String
                let yyy: String
             }
       }
}

のようなクラスを用意し、

let json = try decoder.decode(Response.self, from: data)

でデコードしてます。

NGの時にデコードしようとすると以下のエラーが出ます。

エラーメッセージ
typeMismatch(Swift.Dictionary<Swift.String, Any>, Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "result", intValue: nil), CodingKeys(stringValue: "response", intValue: nil)], debugDescription: "Expected to decode Dictionary<String, Any> but found a string/data instead.", underlyingError: nil))

OKの時もNGの時もResponseクラスを使って対応はできないでしょうか？
デコード時に、responseが空文字か否かで処理を分けられないかと、
enumを使った方法など調べたのですが、私の場合に当てはまらずうまくいきませんでした。

初歩的なことかもしれませんが、ご教示いただけますでしょうか。
よろしくお願い致します。

Answer 1

まあまあ面倒くさいことをしないとダメです。

デコードだけが必要のようなので一部Decoadableにしています。

struct XY: Codable {
    let xxx: String
    let yyy: String
}

struct XYs: Codable {
    let data: [XY]
}

enum ResponseData: Decodable {
    case error(String)
    case data(XYs)
    
    init(from decoder: Decoder) throws {
        
        self = try Result<ResponseData, Error> {
            try .data(decoder.singleValueContainer().decode(XYs.self))
        }
        .flatMapError { _ in
            Result { try .error(decoder.singleValueContainer().decode(String.self)) }
        }
        .get()
    }
}

struct ResultData: Decodable {
    let message: String
    let response: ResponseData
    let status: String
}

struct Response: Decodable {
    let result: ResultData
}

コンパイルもしてないけど多分これで動きます。
responseのところがenumになっているので、使うにはenumから取り出す必要があります。

---

追記：
内側にenumが入るのが嫌であればこんな感じにして一番外側をenumにする。
それでもダメならdo-catchの入れ子を作って対処する。
という感じになります。

---

型名を変更/修正しました。

---

追記（10/17）

let response: Response = /// ここにデコードした値が入っているとします

switch response.result.response {
case let .result(responseData):
    // データが取れたときの処理。 responseDataにXYsの値が入っている
case let .error(error):
    // エラーの時の処理。 errorにStringの値が入っている
}

Comments

[sharman]

ご連絡遅くなり申し訳ありません。
回答いただいたお手本を元に書き直してみました。

①case data(Success)の部分で
「Use of undeclared type 'Success'」

②try .data(decoder.singleValueContainer().decode(XYs.self))の部分で
「Ambiguous reference to member 'decode'」
がそれぞれ出ました。

①Successはどこから出てきたクラスですか？
②多分Encoderのメソッドと区別がつかないのでしょうか？
　decoderはDecoderクラスとはっきりしていると思うのですが、なぜこのエラーが出るかわかりません。

どちらも解決策が浮かばないのですが、原因わかりますでしょうか？

[MasakiHori]

もうしわけない。回答欄上で型名を変更したのが失敗でした。
修正しています。

[sharman]

早急な修正ありがとうございます。コンパイルが通りました。
これを実際に使うとき、Response.error.rawValueで中身を取ろうとしたのですが、それはできませんでした。
連続での質問で申し訳ないですが、enumから取り出すというのはどういうやり方があるのでしょうか？

[MasakiHori]

コメント欄では書けないので回答に追記の形で書いています。
Accociated Valueを持ったenumからその値を取り出すのは一般的にはswitch-case-letが使われます。
if-case-let などで取り出す方法もありますし、それを利用してenumに取り出すメソッドを追加するなどもできます。

[sharman]

追記ありがとうございます。参考にさせていただきました。
成功時はXYs型で受け取っていること、失敗時はString型で受け取っていること、どちらも確認できました。

「Accociated Value」というものを初めて知りました。大変勉強になりました。
ご丁寧にお答え頂き、本当にありがとうございました。

同じことで悩んでここに来る人がいるかもしれないので念の為。
追記の
let response: Response = /// ここにデコードした値が入っているとします
switch response.result.response {
は、変数responseをそのまま使用して
switch response {
ということでいいですか？