SwiftUI JSONキーにハイフン(-)が付いている場合の対処 hyphen

hyphen json JSONEncoder

前回、SwiftJSONDecoderを使った処理方法を書きました。今回JSONキーにハイフンが混ざった処理をご紹介します。ハイフン(hyphen)が入った変数を作成することができません。ビルドエラーになってしまいます。しかしWeb上のAPIにはハイフンが混ざったキーもよく見かけます。例えば下記のようなJSONです。

{ "name-1": "Lenina Crowne" }

この場合”name1“なので下記のようにしたいのですがこれではビルドできません。

ビルドエラー
ビルドエラー

JSONキーにハイフンが含まれる場合CodingKeyが含まれたenum宣言を構造体に埋めてキー名の変換を行います。

struct TJson : Codable {
    var name1: String
    enum CodingKeys : String, CodingKey {
        case name1 = "name-1"
    }
}

enumの名称は「CodingKeys」とする必要があるようです。他の名前ではビルドは成功するものの実行するとエラーになりました。

struct TCodingKeyJSONView: View {
    @State var json1 = """
        { "name-1": "Lenina Crowne" }
    """
    var body: some View {
        Text(jsonConvert(json1).name1)
    }
    func jsonConvert(_ s1: String) -> TJson {
        do {
            return try JSONDecoder().decode(TJson.self, from: s1.data(using: .utf8)! )
        } catch {
            return TJson(name1: "")
        }
    }
}

ハイフンキーが入ったJSONの処理ができました。
ハイフンキーが入ったJSONの処理ができました。

JSONEncoderを使ってTJsonからJSON文字列に変換も試してみました。

struct TCodingKeyJSONView: View {
    var body: some View {
        Text(tJsonToJsonStr(TJson(name1: "Bernard Marx")))
    }
    func tJsonToJsonStr(_ j: TJson) -> String{
        let enc = JSONEncoder()
        do {
            let d1 = try enc.encode(j)
            return String(data: d1, encoding: .utf8)!
        } catch {
            return "{}"
        }
    }
}

JSONEncoderもうまく動きました。

ハイフンキー付きJSON作成する場合のJSONEncoder
ハイフンキー付きJSON作成する場合のJSONEncoder

macOS curlでPOST

curlでAPIGateway POST

AWS API GatewayなどWebAPIのテストを行う場合、さまざまなRESTクライアントツールがありますがmacOSのターミナルからコマンドラインツールのcurlは使い勝手もいいので快適です。curlmacOSのパッケージ管理ツールHomebrewを使えばコマンド1行でインストール可能です。curlのインストールコマンドは下記です。

brew install curl

curlはコマンドにURLを入れるだけでGETとして利用できます。

curl https://mjeld.com/

WebAPIに接続する場合GET以外にもPOST, DELETE, PUTなども使います。その場合下記のようなコマンドで可能です。

# POST の場合
curl -X POST -H "Content-Type: application/json" -d '{"key1":"値1", "key2":"値2"}' https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/xxx

-Xの後をDELETE,PUTに入れ替えることもできます。-Hはヘッダーで-dはデータです。ヘッダーやデータの文字列が多い場合@を付ければファイル名を指定できます。

# DELETE
curl -X DELETE -H @header.txt -d @body.txt https://xxxx.execute-api.ap-northeast-1.amazonaws.com/

# PUT
curl -X PUT -H @header.txt -d @body.txt https://xxxx.execute-api.ap-northeast-1.amazonaws.com/

2022 MJELD TECHNOLOGIES. ALL RIGHTS RESERVED