メニュー
Amazon API Gateway
開発者ガイド

API Gateway コンソールを使用したバイナリサポートの有効化

このセクションでは、API Gateway コンソールを使用してバイナリサポートを有効にする方法ついて説明します。例として、Amazon S3 と統合された API を使用します。サポートされるメディアタイプを設定するタスクと、ペイロードの処理方法を指定する方法に焦点を当てます。Amazon S3 と統合された API を作成する方法の詳細については、「Amazon S3 プロキシとして API を作成する」を参照してください。

API Gateway コンソールを使用してバイナリサポートを有効にするには

  1. API のバイナリメディアタイプの設定

    1. 新しい API を作成するか、既存の API を選択します。この例では、API に FileMan という名前を付けます。

    2. API で [Binary Support] を選択します。

    3. [Binary Support] ペインで、[Edit] を選択します。

    4. [Add binary media types] を選択し、API でサポートする MIME タイプを入力します。

    5. [Save] を選択します。

       API Gateway コンソールでバイナリサポートを追加します。
  2. API メソッドのメッセージペイロードを処理する方法を設定します。

    1. API で新しいリソースを作成するか、既存のリソースを選択します。この例では、/{folder}/{item} リソースを使用します。

    2. リソースで新しいメソッドを作成するか、既存のメソッドを選択します。例として、Amazon S3 で Object GET アクションと統合された GET /{folder}/{item} メソッドを使用します。

    3. [Content Handling] で、オプションを選択します。

       API Gateway コンソールで GET メソッドを設定します。

      クライアントとバックエンドが同じバイナリ形式を受け入れるときに本文を変換しない場合は、[Passthrough] を選択します。たとえば、バイナリリクエストペイロードを JSON プロパティとして渡すことがバックエンドで要求される場合などに、バイナリ本文を Base64 でエンコードされた文字列に変換するには、[Convert to text (if needed)] を選択します。また、クライアントが Base64 でエンコードされた文字列を送信してバックエンドが元のバイナリ形式を要求する場合や、エンドポイントが Base64 でエンコードされた文字列を返してクライアントがバイナリ出力のみ受け入れる場合は、[Convert to binary (if needed)] を選択します。

    4. 統合リクエストで、受信リクエストの Accept ヘッダーを保持します。これは、contentHandlingpassthrough に設定し、実行時にその設定を上書きする場合に行う必要があります。

       統合リクエストで Accept ヘッダーを保持します。
    5. リクエスト本文でパススルー動作を有効にします。

       リクエスト本文のパススルー動作を有効にします。
    6. テキストに変換する場合は、Base64 でエンコードされたバイナリデータを必要な形式にするマッピングテンプレートを定義します。

       テキストへの変換オプションのマッピングテンプレート。

      このマッピングテンプレートの形式は、入力のエンドポイント要件によって異なります。