在 API Gateway 中設定資料轉換

若要建立 AWS CloudFormation 堆疊

1. 開啟位於 https://console.aws.amazon.com/cloudformation 的 AWS CloudFormation 主控台。

2. 選擇 Create stack (建立堆疊)，然後選擇 With new resources (standard) (使用新資源 (標準))。

3. 對於 Specify template (指定範本)，選擇 Upload a template file (上傳範本檔案)。

4. 選取您下載的範本。

5. 選擇 Next (下一步)。

6. 針對 Stack name (堆疊名稱)，輸入 data-transformation-tutorial-console，然後選擇 Next (下一步)。

7. 針對 Configure stack options (設定堆疊選項)，選擇 Next (下一步)。

8. 針對 Capabilities (功能)，請確認 AWS CloudFormation 可以在您的帳戶中建立 IAM 資源。

9. 選擇提交。

測試 GET 整合回應

1. 在 data-transformation-tutorial-console 的 AWS CloudFormation 堆疊的資源索引標籤上，選取 API 的實體 ID。

2. 在主導覽窗格中，選擇資源，然後選取 GET 方法。

3. 選擇測試標籤。您可能需要選擇向右箭頭按鈕才能顯示此索引標籤。

   測試的輸出將顯示下列內容：

   [
     {
       "id": 1,
       "type": "dog",
       "price": 249.99
     },
     {
       "id": 2,
       "type": "cat",
       "price": 124.99
     },
     {
       "id": 3,
       "type": "fish",
       "price": 0.99
     }
   ]

   您將根據 PetStore 對應範本中的對應範本轉換此輸出。

轉換 GET 整合回應

1. 選擇整合回應索引標籤。

   目前，沒有已定義的對應範本，因此不會轉換整合回應。

2. 針對預設 - 回應，選擇編輯。

3. 選擇對應範本，然後執行下列動作：

   1. 選擇新增映射範本。

   2. 針對內容類型，輸入 application/json。

   3. 針對範本內文，輸入下列內容：

      #set($inputRoot = $input.path('$'))
      [
      #foreach($elem in $inputRoot)
        {
          "description" : "Item $elem.id is a $elem.type.",
          "askingPrice" : $elem.price
        }#if($foreach.hasNext),#end
      
      #end
      ]

   選擇儲存。

測試 GET 整合回應

• 選擇測試索引標籤，然後選擇測試。

  測試的輸出將顯示轉換後的回應。

  [
    {
      "description" : "Item 1 is a dog.",
      "askingPrice" : 249.99
    },
    {
      "description" : "Item 2 is a cat.",
      "askingPrice" : 124.99
    },
    {
      "description" : "Item 3 is a fish.",
      "askingPrice" : 0.99
    }
  ]

從 POST 方法轉換輸入資料

1. 選擇 POST 方法。

2. 選擇整合請求索引標籤，然後針對整合請求設定，選擇編輯。

   AWS CloudFormation 範本已填入部分整合請求欄位。

   • 整合類型為 AWS 服務。

   • AWS 服務 為 DynamoDB。

   • HTTP 方法為 POST。

   • 動作為 PutItem。

   • 允許 API Gateway 將項目放入 DynamoDB 資料表的執行角色為 data-transformation-tutorial-console-APIGatewayRole。AWS CloudFormation 會建立此角色，以允許 API Gateway 具有與 DynamoDB 互動的最低許可。

   尚未指定 DynamoDB 資料表的名稱。您將在下列步驟中指定此名稱。

3. 針對請求內文傳遞，選取永不。

   這意味著 API 將拒絕 Content-Type 沒有對應範本的資料。

4. 選擇對應範本。

5. 內容類型會設定為 application/json。這表示不是 application/json 的內容類型將遭 API 拒絕。如需整合傳遞行為的詳細資訊，請參閱 整合傳遞行為。

6. 將下列程式碼輸入至文字編輯器。

   {
       "TableName":"data-transformation-tutorial-console-ddb",
       "Item": {
           "id": {
               "N": $input.json("$.id")
           },
           "type": {
               "S": $input.json("$.type")
           },
           "price": {
               "N": $input.json("$.price")
           }
       }
   }

   此範本會將資料表指定為 data-transformation-tutorial-console-ddb，並將項目設為 id、type 和 price。這些項目將來自 POST 方法的內文。您也可以使用資料模型來協助建立對應範本。如需詳細資訊，請參閱API Gateway 中的 REST API 的請求驗證。

7. 選擇儲存以儲存您的映射範本。

從 POST 方法新增方法和整合回應

AWS CloudFormation 建立了空白方法和整合回應。您將編輯此回應，以提供詳細資訊。如需如何編輯回應的詳細資訊，請參閱 Amazon API Gateway API 請求和回應資料映射參考。

1. 在整合回應索引標籤上，針對預設 - 回應選擇編輯。

2. 選擇對應範本，然後選擇新增對應範本。

3. 針對 Content-Type，輸入 application/json。

4. 在程式碼編輯器中，輸入下列輸出對應範本以傳送輸出訊息：

   { "message" : "Your response was recorded at $context.requestTime" }

   如需內容變數的詳細資訊，請參閱 適用於資料模型、授權方、映射範本及 CloudWatch 存取記錄的 $context 變數。

5. 選擇儲存以儲存您的對應範本。

測試 POST 方法

選擇測試標籤。您可能需要選擇向右箭頭按鈕才能顯示此索引標籤。

1. 在請求內文中，輸入下列範例。

   {
             "id": "4",
             "type" : "dog",
             "price": "321"
   }

2. 選擇測試。

   輸出應該會顯示您的成功訊息。

   您可以在 https://console.aws.amazon.com/dynamodb/ 開啟 DynamoDB 主控台，以驗證範例項目是否位於您的資料表中。

刪除 AWS CloudFormation 堆疊

1. 開啟位於 https://console.aws.amazon.com/cloudformation 的 AWS CloudFormation 主控台。

2. 選取您的 AWS CloudFormation 堆疊。

3. 選擇刪除，然後確認您的選擇。

若要建立 AWS CloudFormation 堆疊

下載並解壓縮應用程式建立範本 AWS CloudFormation。

若要完成下列教學課程，您需要 AWS Command Line Interface (AWS CLI) 第 2 版。

對於長命令，逸出字元 (\) 用於將命令分割為多行。

1. 使用下列命令建立 AWS CloudFormation 堆疊。

   aws cloudformation create-stack --stack-name data-transformation-tutorial-cli --template-body file://data-transformation-tutorial-cli.zip --capabilities CAPABILITY_NAMED_IAM 

2. AWS CloudFormation 佈建在範本中指定的資源。完成資源佈建可能需要幾分鐘的時間。使用下列命令來查看 AWS CloudFormation 堆疊的狀態。

   aws cloudformation describe-stacks --stack-name data-transformation-tutorial-cli

3. 當 AWS CloudFormation 堆疊的狀態為 StackStatus: "CREATE_COMPLETE" 時，請使用下列命令擷取未來步驟的相關輸出值。

    aws cloudformation describe-stacks --stack-name data-transformation-tutorial-cli --query "Stacks[*].Outputs[*].{OutputKey: OutputKey, OutputValue: OutputValue, Description: Description}"

   輸出值如下：

   • ApiRole，這是允許 API Gateway 將項目放入 DynamoDB 資料表的角色名稱。對於本教學課程，角色名稱為 data-transformation-tutorial-cli-APIGatewayRole-ABCDEFG。

   • DDBTableName，這是 DynamoDB 資料表的名稱。對於本教學課程，資料表名稱為 data-transformation-tutorial-cli-ddb。

   • ResourceId，這是 GET 和 POST 方法公開所在寵物資源的 ID。對於本教學課程，資源 ID 為 efg456

   • ApiId，這是 API 的 ID。對於本教學課程，API ID 為 abc123。

在資料轉換之前測試 GET 方法

• 使用下列命令測試 GET 方法。

  aws apigateway test-invoke-method --rest-api-id abc123 \
            --resource-id efg456 \
            --http-method GET

  測試的輸出將顯示下列內容。

  [
    {
      "id": 1,
      "type": "dog",
      "price": 249.99
    },
    {
      "id": 2,
      "type": "cat",
      "price": 124.99
    },
    {
      "id": 3,
      "type": "fish",
      "price": 0.99
    }
  ]

  您將根據 PetStore 對應範本中的對應範本轉換此輸出。

轉換 GET 整合回應

• 使用下列命令更新 GET 方法的整合回應。將 rest-api-id 和 resource-id 取代為您的值。

  使用下列命令建立整合回應。

  aws apigateway put-integration-response --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method GET \
    --status-code 200 \
    --selection-pattern "" \
    --response-templates '{"application/json": "#set($inputRoot = $input.path(\"$\"))\n[\n#foreach($elem in $inputRoot)\n {\n  \"description\": \"Item $elem.id is a $elem.type\",\n  \"askingPrice\": \"$elem.price\"\n }#if($foreach.hasNext),#end\n\n#end\n]"}'

測試 GET 方法

• 使用下列命令測試 GET 方法。

  aws apigateway test-invoke-method --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method GET \
  

  測試的輸出將顯示轉換後的回應。

  [
    {
      "description" : "Item 1 is a dog.",
      "askingPrice" : 249.99
    },
    {
      "description" : "Item 2 is a cat.",
      "askingPrice" : 124.99
    },
    {
      "description" : "Item 3 is a fish.",
      "askingPrice" : 0.99
    }
  ]

建立 POST 方法

1. 使用下列命令，在 /pets 資源上建立新方法。

   aws apigateway put-method --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --authorization-type "NONE" \
   

   此方法可讓您將寵物資訊傳送至您已在 AWS CloudFormation 堆疊中建立的 DynamoDB 資料表。

2. 使用下列命令，在 POST 方法上建立 AWS 服務 整合。

   aws apigateway put-integration --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --type AWS \
     --integration-http-method POST \
     --uri "arn:aws:apigateway:us-east-2:dynamodb:action/PutItem" \
     --credentials arn:aws:iam::111122223333:role/data-transformation-tutorial-cli-APIGatewayRole-ABCDEFG \
     --request-templates '{"application/json":"{\"TableName\":\"data-transformation-tutorial-cli-ddb\",\"Item\":{\"id\":{\"N\":$input.json(\"$.id\")},\"type\":{\"S\":$input.json(\"$.type\")},\"price\":{\"N\":$input.json(\"$.price\")} }}"}'
   

3. 使用下列命令，為 POST 方法的成功呼叫建立方法回應。

   aws apigateway put-method-response --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --status-code 200

4. 使用下列命令，為 POST 方法的成功呼叫建立整合回應。

   aws apigateway put-integration-response --rest-api-id abc123 \
     --resource-id efg456 \
     --http-method POST \
     --status-code 200 \
     --selection-pattern "" \
     --response-templates '{"application/json": "{\"message\": \"Your response was recorded at $context.requestTime\"}"}'

測試 POST 方法

• 使用下列命令測試 POST 方法。

  aws apigateway test-invoke-method --rest-api-id abc123 \
    --resource-id efg456 \
    --http-method POST \
    --body '{\"id\": \"4\", \"type\": \"dog\", \"price\": \"321\"}'

  輸出將顯示成功訊息。

刪除 AWS CloudFormation 堆疊

• 使用下列命令刪除您的 AWS CloudFormation 資源。

  aws cloudformation delete-stack  --stack-name data-transformation-tutorial-cli