【Swift】URLSession で JSONを POST して JSON のレスポンスを受け取る

先日、紹介しましたこれ。

👉 httpbin.org hatena-bookmark


https://httpbin.org/anything/{anything}

に対して JSONを POST するとそのまま JSONで返ってきます。

キー名は「json」です。

※ 以下では POST してないので null。


{
  "args": {},
  "data": "",
  "files": {},
  "form": {},
  "headers": {
    "Accept": "application/json",
    "Accept-Encoding": "gzip, deflate, br, zstd",
    "Accept-Language": "ja-JP,ja;q=0.9,en-US;q=0.8,en;q=0.7",
    "Content-Length": "0",
    "Host": "httpbin.org",
    "Origin": "https://httpbin.org",
    "Priority": "u=1, i",
    "Referer": "https://httpbin.org/",
    "Sec-Ch-Ua": "\"Google Chrome\";v=\"125\", \"Chromium\";v=\"125\", \"Not.A/Brand\";v=\"24\"",
    "Sec-Ch-Ua-Mobile": "?0",
    "Sec-Ch-Ua-Platform": "\"macOS\"",
    "Sec-Fetch-Dest": "empty",
    "Sec-Fetch-Mode": "cors",
    "Sec-Fetch-Site": "same-origin"
  },
  "json": null,  
  "method": "POST",
  "url": "https://httpbin.org/anything/{anything}"
}

練習してみます。

Web-API を使うには必須です。


struct User: Codable {
  var name: String
  var age: Int
}

struct Anything: Codable {
  var json: User
}




let session = URLSession.shared
let url = URL(string: "https://httpbin.org/anything/{anything}")!
let user = User(name: "John", age: 18)

var request = URLRequest(url: url)
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "POST"
request.httpBody = try JSONEncoder().encode(user)

let (data, response) = try await session.data(for: request)
print((response as! HTTPURLResponse).statusCode)
//print(String(data: data, encoding: .utf8)!)

let receivedUser = (try JSONDecoder().decode(Anything.self, from: data)).json

たくさんのキーを持つ JSON がレスポンスで返ってくる場合は、

必要なキーだけを struct のプロパティ(この場合は「json」)

にすれば良いようです。

これで、

「JSON を使った POSTリクエスト」

と

「JSON のレスポンスからクラスオブジェクトを取得」

ができますね!

 

🙆🏻‍♂️ 参考

👉 【Swift】 JSONEncoder / JSONDecorder の基本的な使い方 hatena-bookmark

【Swift】 JSONEncoder / JSONDecorder の基本的な使い方

Apple 公式リファレンスから。サンプルも抜粋。


func encode<T>(_ value: T) throws -> Data where T : Encodable




func decode<T>(
    _ type: T.Type,
    from data: Data
) throws -> T where T : Decodable

👉 encode(_:) | Apple Developer Documentation hatena-bookmark
👉 decode(_:from:) | Apple Developer Documentation hatena-bookmark


struct GroceryProduct: Codable {
  var name: String
  var points: Int
  var description: String?
}

let pear = GroceryProduct(name: "Pear", points: 250, description: "A ripe pear.")

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted

let data = try encoder.encode(pear)
print(String(data: data, encoding: .utf8)!)

/*
{
  "name" : "Pear",
  "points" : 250,
  "description" : "A ripe pear."
}
*/




struct GroceryProduct: Codable {
  var name: String
  var points: Int
  var description: String?
}

let json = """
{
    "name": "Durian",
    "points": 600,
    "description": "A fruit with a distinctive scent."
}
""".data(using: .utf8)!

let decoder = JSONDecoder()
let product = try decoder.decode(GroceryProduct.self, from: json)

print(product.name) 

// Prints "Durian"

👉 JSONEncoder | Apple Developer Documentation hatena-bookmark
👉 JSONDecoder | Apple Developer Documentation hatena-bookmark

Codable というのは、Encodable + Decodable のこと。


typealias Codable = Decodable & Encodable

👉 Codable | Apple Developer Documentation hatena-bookmark

 

🧑🏻‍💻 まとめ

まとめると以下のイメージ。

Data と String の相互変換は以下。


さらに、キー名のカスタムをしたい場合は以下から。

👉 Encoding and Decoding Custom Types | Apple Developer Documentation hatena-bookmark


【Swift】 文字コードの変換 を整理してみた

前にやってみた、これ。


2つの型(プロトコル)の間を相互に変換するだけでも、いろんな書き方があるのだな。

などと思いつつ気になってたのが文字コードの変換。

👉 文字コード - Wikipedia hatena-bookmark

今回、おおまかに整理しておきたい。

 

🧑🏻‍💻 String の内部エンコーディングは UTF-8

Swift 5 switches the preferred encoding of strings from UTF-16 to UTF-8 while preserving efficient Objective-C-interoperability.

👉 Swift.org - UTF-8 String hatena-bookmark

String 内部のエンコーディングは「UTF-8」になったらしいです。

 

🧑🏻‍💻 String、 Data とファイル間での相互変換

図で。大体こんな。

まずは、エンコーディングの引数名が、encoding:, using:, as: と多様なので初見、分かりづらかった。


「String から」または「Stringへ」変換する場合に

「相手」 (「変換先」または「変換元」) のエンコーディングを指定する。

String 自体は「UTF-8」として意識。

Data と ファイル間の変換にはエンコーディングの指定は不要。

Data はそれぞれに変換済みのバイトシーケンス。

 

🧑🏻‍💻 変換してみる

コードを書いて試してみます。

👉 【Swift】よく使いそうな String の format hatena-bookmark


"あいうえお"
  .data(using: .shiftJIS)!.map { String(format: "%02X", $0) }.joined()
// 10 bytes 82A082A282A482A682A8

からスタートして一通り。

以前書いた extension を使っています。

👉 【Swift】ファイルやディレクトリ操作するための extension をまずは作った hatena-bookmark

これで大体いけるはず。

注意としては、「変換できない文字もある」ということ。


o  Shift_JIS → UTF-8 
x  UTF-8     → Shift_JIS

対応する文字がない。

 

🧑🏻‍💻 参考

👉 String.Encoding | Apple Developer Documentation hatena-bookmark
👉 shiftJIS | Apple Developer Documentation hatena-bookmark
👉 init(data:encoding:) | Apple Developer Documentation hatena-bookmark
👉 init(contentsOf:encoding:) | Apple Developer Documentation hatena-bookmark
👉 data(using:allowLossyConversion:) | Apple Developer Documentation hatena-bookmark
👉 write(to:atomically:encoding:) | Apple Developer Documentation hatena-bookmark
👉 init(contentsOf:options:) | Apple Developer Documentation hatena-bookmark
👉 write(to:options:) | Apple Developer Documentation hatena-bookmark