在 API Gateway 中设置数据转换

创建 Amazon CloudFormation 堆栈

1. 打开 Amazon CloudFormation 控制台，地址：https://console.aws.amazon.com/cloudformation。

2. 选择创建堆栈，然后选择使用新资源(标准)。

3. 对于指定模板，选择上传模板文件。

4. 选择您下载的模板。

5. 选择下一步。

6. 对于堆栈名称，输入 data-transformation-tutorial-console，然后选择下一步。

7. 对于配置堆栈选项，请选择下一步。

8. 对于功能，请确认 Amazon CloudFormation 可以在您的账户中创建 IAM 资源。

9. 选择提交。

测试 GET 集成响应

1. 在 data-transformation-tutorial-console 的 Amazon 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. 选择集成请求选项卡，然后对于集成请求设置，选择编辑。

   Amazon CloudFormation 模板已填充了一些集成请求字段。

   • 集成类型为 Amazon Web Service。

   • Amazon Web Service是 DynamoDB。

   • HTTP 方法为 POST。

   • 操作是 PutItem。

   • 允许 API Gateway 将项目放入 DynamoDB 表的执行角色是 data-transformation-tutorial-console-APIGatewayRole。Amazon CloudFormation 创建此角色以允许 API Gateway 拥有与 DynamoDB 交互的最低权限。

   尚未指定 DynamoDB 表的名称。您将在以下步骤中指定名称。

3. 对于请求正文传递，选择从不。

   这意味着 API 将拒绝其 Content-Type（内容类型）没有映射模板的数据。

4. 选择映射模板。

5. 内容类型设置为 application/json。这意味着 API 将拒绝所有不是 application/json 的内容类型。有关集成传递行为的更多信息，请参阅集成传递行为

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 中使用请求验证。

7. 选择保存以保存映射模板。

从 POST 方法添加方法和集成响应

Amazon 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 控制台，以验证示例项目是否在您的表中。

删除 Amazon CloudFormation 堆栈

1. 打开 Amazon CloudFormation 控制台，地址：https://console.aws.amazon.com/cloudformation。

2. 选择您的 Amazon CloudFormation 堆栈。

3. 选择删除，然后确认您的选择。

创建 Amazon CloudFormation 堆栈

下载并解压缩适用于 Amazon CloudFormation 的应用程序创建模板。

要完成以下教程，您需要 Amazon Command Line Interface（Amazon CLI）版本 2。

对于长命令，使用转义字符 (\) 将命令拆分为多行。

1. 输入以下命令创建 Amazon CloudFormation 堆栈。

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

2. Amazon CloudFormation 预置在模板中指定的资源。完成资源预置可能需要几分钟时间。使用以下命令查看 Amazon CloudFormation 的状态。

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

3. 当 Amazon 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" \
   

   此方法允许您将宠物信息发送到您在 Amazon CloudFormation 堆栈中创建的 DynamoDB 表。

2. 使用以下命令在 POST 方法上创建 Amazon Web Service 集成。

   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\"}'

  输出将显示成功消息。

删除 Amazon CloudFormation 堆栈

• 使用以下命令删除您的 Amazon CloudFormation 资源。

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