使用 API Gateway 主控台設定資料轉換使用 AWS CLI 設定資料轉換完成的資料轉換 AWS CloudFormation 範本後續步驟

在 API Gateway 中設定資料轉換

本節說明如何設定對應範本，以使用主控台和 AWS CLI 轉換整合要求和回應。

主題

使用 API Gateway 主控台設定資料轉換
使用 AWS CLI 設定資料轉換
完成的資料轉換 AWS CloudFormation 範本
後續步驟

使用 API Gateway 主控台設定資料轉換

在本教學課程中，您將使用下列 .zip 檔案建立不完整的 API 和 DynamoDB 資料表。data-transformation-tutorial-console此不完整的 API 具有 /pets 資源，其中含有 GET 和 POST 方法。

GET 方法將從 http://petstore-demo-endpoint.execute-api.com/petstore/pets HTTP 端點取得資料。輸出資料將根據 PetStore 對映樣板中的對應範本進行轉換。
POST 方法可讓使用者使用對應範本，將寵物資訊 POST 至 Amazon DynamoDB 資料表。

下載並解壓縮的應用程式建立範本。 AWS CloudFormation您將使用此範本建立 DynamoDB 資料表，以發布寵物資訊和不完整的 API。您將完成 API Gateway 主控台中的其餘步驟。

建立 AWS CloudFormation 堆疊的步驟

開啟主 AWS CloudFormation 控台，網址為 https://console.aws.amazon.com/cloudformation。
選擇 Create stack (建立堆疊)，然後選擇 With new resources (standard) (使用新資源 (標準))。
對於 Specify template (指定範本)，選擇 Upload a template file (上傳範本檔案)。
選取您下載的範本。
選擇 Next (下一步)。
針對 Stack name (堆疊名稱)，輸入 data-transformation-tutorial-console，然後選擇 Next (下一步)。
針對 Configure stack options (設定堆疊選項)，選擇 Next (下一步)。
對於功能，請確認 AWS CloudFormation 可以在您的帳戶中建立 IAM 資源。
選擇提交。

AWS CloudFormation 規定範本中指定的資源。完成資源佈建可能需要幾分鐘的時間。當 AWS CloudFormation 堆疊的狀態為「建立 _ 完成」時，您就可以繼續進行下一個步驟。

測試 `GET` 整合回應

在的 AWS CloudFormation 堆疊的 [資源] 索引標籤上data-transformation-tutorial-console，選取 API 的實體 ID。
在主導覽窗格中，選擇資源，然後選取 GET 方法。

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

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


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

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

轉換 `GET` 整合回應

選擇整合回應索引標籤。

目前，沒有已定義的對應範本，因此不會轉換整合回應。
針對預設 - 回應，選擇編輯。

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

選擇新增對應範本。
針對內容類型，輸入 application/json。

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


#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` 方法轉換輸入資料

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

AWS CloudFormation 範本已填入部分整合要求欄位。
- 整合類型為 AWS 服務。
- 就 AWS 服務是 DynamoDB。
- HTTP 方法為 POST。
- 動作為 PutItem。
- 允許 API Gateway 將項目放入 DynamoDB 表格的執行角色為。data-transformation-tutorial-console-APIGatewayRole AWS CloudFormation 建立此角色以允許 API Gateway 具有與 DynamoDB 互動的最低權限。
尚未指定 DynamoDB 資料表的名稱。您將在下列步驟中指定此名稱。
針對請求內文傳遞，選取永不。

這意味著 API 將拒絕 Content-Type 沒有對應範本的資料。
選擇對應範本。
內容類型會設定為 application/json。這表示不是 application/json 的內容類型將遭 API 拒絕。如需整合傳遞行為的詳細資訊，請參閱整合傳遞行為。

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


{
    "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 要求驗證。

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

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

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

在整合回應索引標籤上，針對預設 - 回應選擇編輯。
選擇對應範本，然後選擇新增對應範本。
針對 Content-Type，輸入 application/json。
在程式碼編輯器中，輸入下列輸出對應範本以傳送輸出訊息：
```
{ "message" : "Your response was recorded at $context.requestTime" }
```
如需內容變數的詳細資訊，請參閱 $context資料模型、授權者、對應範本和 CloudWatch 存取記錄的變數。
選擇儲存以儲存您的對應範本。

測試 `POST` 方法

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

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


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

選擇測試。

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

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

刪除 AWS CloudFormation 堆疊的步驟

開啟主 AWS CloudFormation 控台，網址為 https://console.aws.amazon.com/cloudformation。
選取您的 AWS CloudFormation 堆疊。
選擇刪除，然後確認您的選擇。

使用 AWS CLI 設定資料轉換

在本教學課程中，您將使用下列 .zip 檔案建立不完整的 API 和 DynamoDB 資料表。data-transformation-tutorial-cli這個不完整的 API 具有 /pets 資源，其中含有與 http://petstore-demo-endpoint.execute-api.com/petstore/pets HTTP 端點整合的 GET 方法。您將建立 POST 方法，以連線至 DynamoDB 資料表，並使用對應範本將資料輸入至 DynamoDB 資料表。

您將根據 PetStore 對映樣板中的對應範本轉換輸出資料。
您將建立 POST 方法，允許使用者使用對應範本，將寵物資訊 POST 至 Amazon DynamoDB 資料表。

建立 AWS CloudFormation 堆疊的步驟

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

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

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

注意

在 Windows 中，作業系統的內建終端機不支援您常用的某些 Bash CLI 命令 (例如 zip)。若要取得 Ubuntu 和 Bash 的 Windows 整合版本，請安裝適用於 Linux 的 Windows 子系統。本指南中的 CLI 命令範例使用 Linux 格式。如果您使用的是 Windows CLI，必須重新格式化包含內嵌 JSON 文件的命令。

使用下面的命令來創建 AWS CloudFormation 堆棧。


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

AWS CloudFormation 規定範本中指定的資源。完成資源佈建可能需要幾分鐘的時間。使用以下命令查看 AWS CloudFormation 堆棧的狀態。
```
aws cloudformation describe-stacks --stack-name data-transformation-tutorial-cli
```
當 AWS CloudFormation 堆棧的狀態為時StackStatus: "CREATE_COMPLETE"，請使用以下命令檢索 future 步驟的相關輸出值。
```
 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 的識別碼。對於本教學課程，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和資源 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` 方法

使用下列命令，在 /pets 資源上建立新方法。
```
aws apigateway put-method --rest-api-id abc123 \
  --resource-id efg456 \
  --http-method POST \
  --authorization-type "NONE" \
```
此方法可讓您將寵物資訊傳送至您在堆疊中建立的 DynamoDB 表格。 AWS CloudFormation

使用以下命令在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\")} }}"}'

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


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

使用下列命令，為 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

完成的資料轉換 AWS CloudFormation 範本

下列範例是完整的 AWS CloudFormation 範本，它會建立包含和方法/pets資源的 API GET 和 POST DynamoDB 表格。

GET 方法將從 http://petstore-demo-endpoint.execute-api.com/petstore/pets HTTP 端點取得資料。輸出資料將根據 PetStore 對映樣板中的對應範本進行轉換。
POST 方法可讓使用者使用對應範本，將寵物資訊 POST 至 DynamoDB 資料表。


AWSTemplateFormatVersion: 2010-09-09
Description: A completed Amazon API Gateway REST API that uses non-proxy integration to POST to an Amazon DynamoDB table and non-proxy integration to GET transformed pets data.
Parameters:
  StageName:
    Type: String
    Default: v1
    Description: Name of API stage.
Resources:
  DynamoDBTable:
    Type: 'AWS::DynamoDB::Table'
    Properties:
      TableName: !Sub data-transformation-tutorial-complete
      AttributeDefinitions:
        - AttributeName: id
          AttributeType: N
      KeySchema:
        - AttributeName: id
          KeyType: HASH
      ProvisionedThroughput:
        ReadCapacityUnits: 5
        WriteCapacityUnits: 5
  APIGatewayRole:
    Type: 'AWS::IAM::Role'
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Action:
              - 'sts:AssumeRole'
            Effect: Allow
            Principal:
              Service:
                - apigateway.amazonaws.com
      Policies:
        - PolicyName: APIGatewayDynamoDBPolicy
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - 'dynamodb:PutItem'
                Resource: !GetAtt DynamoDBTable.Arn
  Api:
    Type: 'AWS::ApiGateway::RestApi'
    Properties:
      Name: data-transformation-complete-api
      ApiKeySourceType: HEADER
  PetsResource:
    Type: 'AWS::ApiGateway::Resource'
    Properties:
      RestApiId: !Ref Api
      ParentId: !GetAtt Api.RootResourceId
      PathPart: 'pets'
  PetsMethodGet:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      RestApiId: !Ref Api
      ResourceId: !Ref PetsResource
      HttpMethod: GET
      ApiKeyRequired: false
      AuthorizationType: NONE
      Integration:
        Type: HTTP
        Credentials: !GetAtt APIGatewayRole.Arn
        IntegrationHttpMethod: GET
        Uri: http://petstore-demo-endpoint.execute-api.com/petstore/pets/
        PassthroughBehavior: WHEN_NO_TEMPLATES
        IntegrationResponses:
          - StatusCode: '200'
            ResponseTemplates:
              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]"
      MethodResponses:
        - StatusCode: '200'
  PetsMethodPost:
    Type: 'AWS::ApiGateway::Method'
    Properties:
      RestApiId: !Ref Api
      ResourceId: !Ref PetsResource
      HttpMethod: POST
      ApiKeyRequired: false
      AuthorizationType: NONE
      Integration:
        Type: AWS
        Credentials: !GetAtt APIGatewayRole.Arn
        IntegrationHttpMethod: POST
        Uri: arn:aws:apigateway:us-west-1:dynamodb:action/PutItem
        PassthroughBehavior: NEVER
        RequestTemplates: 
          application/json: "{\"TableName\":\"data-transformation-tutorial-complete\",\"Item\":{\"id\":{\"N\":$input.json(\"$.id\")},\"type\":{\"S\":$input.json(\"$.type\")},\"price\":{\"N\":$input.json(\"$.price\")} }}"
        IntegrationResponses:
          - StatusCode: 200
            ResponseTemplates:
              application/json: "{\"message\": \"Your response was recorded at $context.requestTime\"}"
      MethodResponses:
        - StatusCode: '200'

  ApiDeployment:
    Type: 'AWS::ApiGateway::Deployment'
    DependsOn:
      - PetsMethodGet
    Properties:
      RestApiId: !Ref Api
      StageName: !Sub '${StageName}'
Outputs:
  ApiId:
    Description: API ID for CLI commands
    Value: !Ref Api
  ResourceId:
    Description: /pets resource ID for CLI commands
    Value: !Ref PetsResource
  ApiRole:
    Description: Role ID to allow API Gateway to put and scan items in DynamoDB table
    Value: !Ref APIGatewayRole
  DDBTableName:
    Description: DynamoDB table name
    Value: !Ref DynamoDBTable

後續步驟

若要探索更複雜的對應範本，請參閱下列範例：

查看更複雜的模型和對應範本，其中具有範例相簿相簿範例。
若要取得關於模型的詳細資訊，請參閱適用於其他 API 的資料模型。
如需如何對應不同回應代碼輸出的相關資訊，請參閱使用 API Gateway 主控台設定請求與回應資料映射。
如需如何從 API 的方法請求資料設定資料對應的相關資訊，請參閱 API Gateway 映射範本和存取記錄變數參考。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

適用於其他 API 的對應範本

使用對應範本來覆寫 API 請求和回應參數和狀態碼

在 API Gateway 中設定資料轉換

主題

使用 API Gateway 主控台設定資料轉換

建立 AWS CloudFormation 堆疊的步驟

測試 GET 整合回應

轉換 GET 整合回應

測試 GET 整合回應

從 POST 方法轉換輸入資料

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

測試 POST 方法

刪除 AWS CloudFormation 堆疊的步驟

使用 AWS CLI 設定資料轉換

建立 AWS CloudFormation 堆疊的步驟

注意

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

轉換 GET 整合回應

測試 GET 方法

建立 POST 方法

測試 POST 方法

刪除 AWS CloudFormation 堆疊的步驟

完成的資料轉換 AWS CloudFormation 範本

後續步驟

測試 `GET` 整合回應

轉換 `GET` 整合回應

測試 `GET` 整合回應

從 `POST` 方法轉換輸入資料

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

測試 `POST` 方法

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

轉換 `GET` 整合回應

測試 `GET` 方法

建立 `POST` 方法

測試 `POST` 方法