AWS ドキュメント » Amazon API Gateway » 開発者ガイド » Amazon API Gateway での API の作成 » API Gateway の API 統合を設定する » API Gateway の HTTP 統合をセットアップする

API Gateway の HTTP 統合をセットアップする

HTTP プロキシ統合または HTTP カスタム統合を使用して、API メソッドを HTTP エンドポイントに統合できます。

プロキシ統合を使用する場合、セットアップは簡単です。コンテンツのエンコーディングやキャッシングが不要な場合は、バックエンド要件に従って HTTP メソッドと HTTP エンドポイント URI を設定するだけで済みます。

カスタム統合を使用する場合、セットアップは複雑になります。プロキシ統合のセットアップ手順に加えて、受信リクエストデータがどのように統合リクエストにマッピングされるか、統合レスポンスデータの結果がメソッド応答にどのようにマッピングされるかを指定する必要があります。

API Gateway の HTTP プロキシ統合をセットアップする

プロキシリソース に HTTP プロキシ統合タイプをセットアップするには、greedy パスパラメーター (/parent/{proxy+} など) を使用して API リソースを作成し、このリソースを ANY メソッドで HTTP バックエンドのエンドポイント (https://petstore-demo-endpoint.execute-api.com/petstore/{proxy} など) と統合します。greedy パスパラメーターは、リソースパスの末尾にある必要があります。

非プロキシリソースと同様に、API Gateway コンソールを使用するか、Swagger 定義ファイルをインポートするか、API Gateway REST API を直接呼び出すことによって、プロキシリソースに HTTP プロキシ統合をセットアップできます。API Gateway コンソールを使用してプロキシリソースに HTTP 統合を設定する詳しい手順については、「HTTP プロキシ統合で API をビルドする 」を参照してください。

以下の Swagger API 定義ファイルは、PetStore ウェブサイトに統合された API とプロキシリソースの例を示しています。

{
  "swagger": "2.0",
  "info": {
    "version": "2016-09-12T23:19:28Z",
    "title": "PetStoreWithProxyResource"
  },
  "host": "4z9giyi2c1.execute-api.us-east-1.amazonaws.com",
  "basePath": "/test",
  "schemes": [
    "https"
  ],
  "paths": {
    "/{proxy+}": {
      "x-amazon-apigateway-any-method": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "proxy",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {},
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "requestParameters": {
            "integration.request.path.proxy": "method.request.path.proxy"
          },
          "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/{proxy}",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "ANY",
          "cacheNamespace": "rbftud",
          "cacheKeyParameters": [
            "method.request.path.proxy"
          ],
          "type": "http_proxy"
        }
      }
    }
  }
}

この例では、キャッシュのキーは、プロキシリソースの method.request.path.proxy パスパラメーターで宣言されます。これにより、API Gateway コンソールを使用して API を作成するときのデフォルト設定です。API ベースパス (/test、ステージに対応) はウェブサイトの PetStore ページ (/petstore) にマッピングされます。単一の統合リクエストは、API の greedy パス変数とキャッチオールの ANY メソッドを使用して、PetStore ウェブサイト全体をミラーリング処理します。以下の例に、このミラーリングを示しています。

クライアントリクエストの場合、対象のエンドポイント URL が無効であるか、HTTP 動詞が有効であってもサポートされていない場合、ベック遠渡は 404 Not Found レスポンスを返します。サポートされていない HTTP メソッドの場合は、403 Forbidden レスポンスが返されます。

API Gateway の HTTP カスタム統合をセットアップする

HTTP カスタム統合により、API メソッドと API 統合の間を行き来するデータと行き来の方法をより詳細に制御できます。これにはデータマッピングを使用します。

メソッドリクエストのセットアップの一環として、Method リソースで requestParameters プロパティを設定します。これにより、クライアントからプロビジョニングされるメソッドリクエストパラメーターのうち、バックエンドにディスパッチされる前に統合リクエストパラメーターや該当する本文プロパティにマッピングされるものが宣言されます。次に、統合リクエストのセットアップの一環として、対応する Integration リソースで requestParameters プロパティを設定し、パラメーター間のマッピングを指定します。また、requestTemplates プロパティを設定し、サポートされているコンテンツタイプにつき 1 つずつ、マッピングテンプレートを指定します。マッピングテンプレートは、メソッドリクエストパラメーターや本文を統合リクエストボディにマッピングします。

同様に、メソッドレスポンスのセットアップの一環として、MethodResponse リソースで responseParameters プロパティを設定します。これにより、クライアントにディスパッチされるメソッドレスポンスパラメーターのうち、統合レスポンスパラメーターからまたはバックエンドから返された該当する本文プロパティからマッピングされるものが宣言されます。次に、統合レスポンスのセットアップの一環として、対応する IntegrationResponse リソースで responseParameters プロパティを設定し、パラメーター間のマッピングを指定します。また、responseTemplates マップを設定し、サポートされているコンテンツタイプごとにマッピングテンプレートを 1 つずつ指定します。マッピングテンプレートは、統合レスポンスパラメーターや統合レスポンス本文のプロパティをメソッドレスポンス本文にマッピングします。

マッピングテンプレートのセットアップの詳細については、「データマッピングをセットアップする」を参照してください。

このページの内容:

• API Gateway の HTTP プロキシ統合をセットアップする
• HTTP カスタム統合のセットアップ