Swiftで楽天レシピAPIから取得したJSONデータを活用する方法

はじめに (対象読者・この記事でわかること)

この記事は、Swiftを使ったiOSアプリケーション開発に興味がある方、特に外部APIから取得したデータを活用したいと考えている方を対象としています。具体的には、楽天レシピAPIから取得したJSON形式のレシピデータをSwiftのオブジェクトに変換し、アプリ内で表示・利用できるようにするまでの一連の流れを解説します。

この記事を読むことで、以下のことがわかるようになります。

楽天レシピAPIの基本的な使い方と、APIキーの取得方法
URLSession を用いた非同期でのAPIリクエスト送信方法
取得したJSONデータをSwiftで扱えるようにデコードする方法
デコードしたデータをアプリ画面に表示するための基本的な考え方

API連携は、現代のアプリケーション開発において非常に重要なスキルです。この記事を通じて、その第一歩を踏み出しましょう。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

Swiftの基本的な文法（変数、型、構造体、クラス、Optionalなど）
Xcodeを使った基本的なiOSアプリケーション開発の知識
Codable プロトコルについての基本的な理解（必須ではありませんが、あると理解が深まります）

楽天レシピAPIの概要とAPIキーの取得

楽天レシピAPIとは

楽天レシピAPIは、楽天が提供するレシピ情報にアクセスできるAPIです。このAPIを利用することで、様々なレシピデータをアプリケーションに組み込むことができます。例えば、ユーザーの好みに合わせたレシピの検索、おすすめレシピの表示、特定の食材を使ったレシピの提案などが可能になります。

APIキーの取得手順

楽天レシピAPIを利用するには、まず楽天DevelopersにてAPIキー（アフィリエイトID）を取得する必要があります。

楽天Developersにアクセス: https://developer.rakuten.co.jp/ へアクセスし、アカウント登録またはログインを行います。
アプリケーションの登録: 「アプリケーションの登録」メニューから、新規アプリケーションを登録します。
APIキー（アフィリエイトID）の確認: アプリケーション登録が完了すると、アフィリエイトIDが発行されます。これがAPIキーとして利用できます。 ※APIキーは第三者に漏洩しないよう、厳重に管理してください。

APIエンドポイントとパラメータ

楽天レシピAPIの主要なエンドポイントの一つに、レシピ検索APIがあります。このAPIを利用する際には、以下のようなパラメータを指定します。

applicationId: 取得したアフィリエイトID
keyword: 検索したいレシピのキーワード（例: "鶏肉", "カレー"）
format: レスポンスの形式（通常は "json"）
hits: 取得する件数
page: ページ番号

これらのパラメータを組み合わせることで、目的に合ったレシピデータを取得できます。

Swiftでの楽天レシピAPIからのJSONデータ取得とデコード

APIリクエストの送信とJSONデータの取得

SwiftでAPIからデータを取得するには、URLSession を使用するのが一般的です。非同期処理となるため、async/await 構文やクロージャを用いて、バックグラウンドでデータ取得を行い、完了後にUIを更新するなどの処理を行います。

まず、APIリクエストに必要なURLを構築します。

Swift

import Foundation

func fetchRecipes(keyword: String, completion: @escaping (Result<[Recipe], Error>) -> Void) {
    guard let appId = "YOUR_APP_ID" else { // ここに取得したアフィリエイトIDを入力
        print("アプリケーションIDが設定されていません。")
        return
    }

    var urlComponents = URLComponents(string: "https://app.rakuten.co.jp/services/api/recipe/simpleSearch/20170426")!
    urlComponents.queryItems = [
        URLQueryItem(name: "applicationId", value: appId),
        URLQueryItem(name: "keyword", value: keyword),
        URLQueryItem(name: "format", value: "json")
    ]

    guard let url = urlComponents.url else {
        print("URLの構築に失敗しました。")
        return
    }

    URLSession.shared.dataTask(with: url) { data, response, error in
        if let error = error {
            completion(.failure(error))
            return
        }

        guard let httpResponse = response as? HTTPURLResponse,
              (200...299).contains(httpResponse.statusCode) else {
            print("HTTPレスポンスエラー")
            completion(.failure(NSError(domain: "com.example.recipeapp", code: 0, userInfo: [NSLocalizedDescriptionKey: "HTTP Response was not 2xx"])))
            return
        }

        guard let data = data else {
            print("データが返却されませんでした。")
            completion(.failure(NSError(domain: "com.example.recipeapp", code: 1, userInfo: [NSLocalizedDescriptionKey: "No data received"])))
            return
        }

        // JSONデコード処理は次のセクションで行います
        completion(.success([])) // 仮の返却
    }.resume()
}

JSONデータのデコード：Swiftの構造体で形作る

APIから取得したJSONデータは、そのままではSwiftで直接扱えません。JSONの構造に合わせてSwiftの構造体（struct）を定義し、Codable プロトコル（Decodable および Encodable の両方を含む）に準拠させることで、JSONをSwiftオブジェクトに変換（デコード）できるようになります。

まず、楽天レシピAPIのレスポンスJSONの構造を理解する必要があります。楽天レシピAPIのドキュメントを参照しながら、必要な部分をSwiftの構造体にマッピングしていきます。

例：楽天レシピAPIのレスポンスJSON構造（抜粋）

Json

{
  "resultsReturned": 10,
  "resultsStart": 0,
  "resultTotal": 1000,
  "Recipes": [
    {
      "Recipe": {
        "recipeId": 1234567,
        "recipeTitle": "簡単鶏肉の照り焼き",
        "foodImageUrl": "https://example.com/image.jpg",
        "caption": "ごはんが進む定番の味",
        "genre": {
          "genreId": 10,
          "name": "和食"
        },
        "ingredients": [
          "鶏もも肉",
          "醤油",
          "みりん",
          "砂糖"
        ],
        "source": "楽天レシピ",
        "url": "https://recipe.rakuten.co.jp/recipe/123-4567/"
      }
    }
    // ... 他のレシピ
  ]
}

このJSON構造を基に、Swiftの構造体を定義します。JSONのキー名とSwiftのプロパティ名が一致しない場合は、@JSONKey 属性（またはKeyedDecodingContainer を使用）でマッピングを行います。

Swift

// JSONのトップレベル構造体
struct RecipeSearchResponse: Codable {
    let resultsReturned: Int
    let recipes: [RecipeWrapper]

    // JSONのキー名が"Recipes"なので、Swiftのプロパティ名を"recipes"にするためにマッピング
    enum CodingKeys: String, CodingKey {
        case resultsReturned = "resultsReturned"
        case recipes = "Recipes"
    }
}

// 各レシピをラップしている構造体
struct RecipeWrapper: Codable {
    let recipe: Recipe
}

// レシピの詳細情報を持つ構造体
struct Recipe: Codable {
    let id: Int
    let title: String
    let imageUrl: URL
    let caption: String
    let ingredients: [String]
    let source: String
    let url: URL

    // JSONのキー名とSwiftのプロパティ名が異なる場合のマッピング
    enum CodingKeys: String, CodingKey {
        case id = "recipeId"
        case title = "recipeTitle"
        case imageUrl = "foodImageUrl"
        case caption = "caption"
        case ingredients = "ingredients"
        case source = "source"
        case url = "url"
    }
}

これらの構造体を定義したら、先ほどのfetchRecipes関数内でJSONデコード処理を追加します。

Swift

// fetchRecipes関数のURLSession.shared.dataTask {...} 内の completion(.success([])) を以下のコードで置き換えます。

        do {
            let decoder = JSONDecoder()
            // JSONのキー名とSwiftのプロパティ名が異なる場合、KeyedDecodingStrategyで自動マッピングさせることも可能
            // decoder.keyDecodingStrategy = .convertFromSnakeCase // 例: snake_case を camelCase に変換

            let response = try decoder.decode(RecipeSearchResponse.self, from: data)
            let recipes = response.recipes.map { $0.recipe } // RecipeWrapperからRecipeを取り出す
            completion(.success(recipes))
        } catch {
            print("JSONデコードエラー: \(error)")
            completion(.failure(error))
        }

JSONデコード後のデータ活用

デコードに成功すると、Recipe構造体の配列としてレシピデータが取得できます。これを元に、UITableViewやUICollectionViewにレシピのタイトル、画像、説明などを表示させることができます。

例えば、以下のようなコードでレシピのタイトルと画像を表示できます（UI部分のコードは省略しています）。

Swift

// fetchRecipes関数から取得したrecipes配列を使ってUIを更新する処理
func updateUI(with recipes: [Recipe]) {
    // recipes配列を元に、tableViewやcollectionViewなどのUI要素を更新する
    for recipe in recipes {
        print("レシピタイトル: \(recipe.title)")
        print("画像URL: \(recipe.imageUrl)")
        print("概要: \(recipe.caption)")
        print("----------")
    }
}

// API呼び出し部分
fetchRecipes(keyword: "鶏肉") { result in
    DispatchQueue.main.async { // UIの更新はメインスレッドで行う
        switch result {
        case .success(let recipes):
            updateUI(with: recipes)
        case .failure(let error):
            print("レシピの取得に失敗しました: \(error.localizedDescription)")
            // エラーメッセージをユーザーに表示するなどの処理
        }
    }
}

ハマった点やエラー解決

APIキーの指定漏れ: applicationId に取得したアフィリエイトIDを正しく設定しないと、APIリクエストが失敗します。
JSON構造の不一致: APIのレスポンスJSON構造が変更された場合、Swiftの構造体定義もそれに合わせて修正する必要があります。APIドキュメントを常に最新の状態に保ち、JSONの構造を正確に把握することが重要です。
Optional型: JSONデータにはnullが含まれる可能性があるため、Swiftの構造体で該当するプロパティはOptional型（?）で宣言することが推奨されます。デコード時にnullがあった場合でもクラッシュを防ぐことができます。
URLの構築ミス: URLComponents の queryItems に誤ったキー名や値を設定すると、APIリクエストが正しく機能しません。

解決策

APIキーは定数として保持し、アプリケーション内で安全に管理します。
print() 文やデバッガーを活用し、APIから返却されたJSONデータを確認します。PostmanなどのAPIテストツールも有効です。
Codable プロトコルを理解し、JSONの構造をSwiftの構造体に正確にマッピングします。複雑なJSON構造の場合は、KeyedDecodingContainer を使ってより柔軟なデコード処理を実装します。
エラーハンドリングを適切に行い、APIリクエストやデコード処理で発生したエラーを捕捉し、ユーザーに分かりやすく伝えるようにします。

まとめ

本記事では、Swiftを使って楽天レシピAPIからレシピデータを取得し、JSON形式で返却されたデータをSwiftのオブジェクトにデコードする手順を解説しました。

楽天レシピAPIの利用方法: APIキーの取得、URLの構築、パラメータの設定方法について説明しました。
JSONデコードの実装: Codable プロトコルに準拠したSwift構造体の定義、URLSession と JSONDecoder を用いたデコード処理の実装方法を示しました。
データ活用の基礎: デコードされたレシピデータをアプリ内で活用するための基本的な考え方について触れました。

この記事を通して、API連携とJSONデータの扱いの重要性を理解し、ご自身のアプリケーション開発に活かせる知識を得られたはずです。今後は、取得したレシピデータを画面に表示するUIの実装や、検索機能の拡充など、さらに発展的な内容についても挑戦してみてください。

Swiftで楽天レシピAPIから取得したJSONデータを活用する方法🍜