Einrichten von Datentransformationen in API Gateway

So erstellen Sie einen AWS CloudFormation-Stack

1. Öffnen Sie die AWS CloudFormation-Konsole unter https://console.aws.amazon.com/cloudformation.

2. Wählen Sie Stack erstellen und dann Mit neuen Ressourcen (Standard) aus.

3. Wählen Sie unter Vorlage angeben die Option Vorlagendatei hochladen aus.

4. Wählen Sie die Vorlage aus, die Sie heruntergeladen haben.

5. Wählen Sie Weiter aus.

6. Geben Sie für Stack-Name die Zeichenfolge data-transformation-tutorial-console ein und klicken Sie auf Weiter.

7. Wählen Sie in Stack-Optionen konfigurieren die Option Weiter aus.

8. Bestätigen Sie in Funktionen, dass AWS CloudFormation IAM-Ressourcen in Ihrem Konto erstellen darf.

9. Wählen Sie Absenden aus.

So testen Sie die GET-Integrationsantwort

1. Wählen Sie auf der Registerkarte Ressourcen des AWS CloudFormation-Stacks für data-transformation-tutorial-console die physische ID Ihrer API aus.

2. Klicken Sie im Hauptnavigationsbereich auf Ressourcen und wählen Sie dann die GET-Methode in der Ressourcenstruktur aus.

3. Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.

   Das Ergebnis des Tests wird Folgendes zeigen:

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

   Sie transformieren diese Ausgabe gemäß der Zuweisungsvorlage in PetStore-Zuweisungsvorlage.

So transformieren Sie die GET-Integrationsantwort

1. Klicken Sie auf die Registerkarte Integrationsantwort.

   Derzeit sind keine Zuweisungsvorlagen definiert, sodass die Integrationsantwort nicht transformiert wird.

2. Klicken Sie unter Standard - Antwort auf Bearbeiten.

3. Wählen Sie Vorlagen zuordnen aus und gehen Sie dann wie folgt vor:

   1. Wählen Sie Add mapping template.

   2. Geben Sie für Content type (Inhaltstyp) application/json ein.

   3. Geben Sie für Vorlagentext Folgendes ein:

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

   Wählen Sie Save (Speichern) aus.

So testen Sie die GET-Integrationsantwort

• Wählen Sie die Registerkarte Test und dann Test aus

  Die Ausgabe des Tests zeigt die transformierte Antwort.

  [
    {
      "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
    }
  ]

So transformieren Sie Eingabedaten aus der POST-Methode

1. Wählen Sie die POST-Methode aus.

2. Wählen Sie die Registerkarte Integrationsanfrage aus und klicken Sie dann unter Einstellungen für Integrationsanforderungen auf Bearbeiten.

   In der AWS CloudFormation-Vorlage sind einige der Felder für Integrationsanfragen ausgefüllt.

   • Der Integrationstyp ist AWS-Service.

   • Der AWS-Service ist DynamoDB.

   • Die HTTP-Methode ist POST.

   • Die Aktion ist PutItem.

   • Die Ausführungsrolle, die API Gateway ermöglicht, ein Element in die DynamoDB-Tabelle einzufügen, ist data-transformation-tutorial-console-APIGatewayRole. AWS CloudFormation hat diese Rolle erstellt, damit API Gateway über die Mindestberechtigungen für die Interaktion mit DynamoDB verfügt.

   Der Name der DynamoDB-Tabelle wurde nicht angegeben. In den folgenden Schritten geben Sie den Namen an.

3. Für Text-Passthrough anfordern wählen Sie Nie aus.

   Dies bedeutet, dass die API Daten mit Inhaltstypen ablehnt, die keine Zuweisungsvorlage haben.

4. Wählen Sie Zuordnungsvorlagen aus.

5. Der Inhaltstyp ist auf application/json gesetzt. Das bedeutet, dass alle Inhaltstypen, die nicht „application/json“ sind, von der API abgelehnt werden. Weitere Informationen zu Integrations-Passthrough-Verhaltensweisen finden Sie unter Integrations-Pass-Through-Verhalten.

6. Geben Sie den folgenden Code in den Texteditor ein.

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

   Diese Vorlage spezifiziert die Tabelle als data-transformation-tutorial-console-ddb und legt die Elemente als id, type und price fest. Die Elemente kommen aus dem Hauptteil der POST-Methode. Sie können auch ein Datenmodell verwenden, um eine Zuweisungsvorlage zu erstellen. Weitere Informationen finden Sie unter Anforderungsvalidierung für REST-APIs in API Gateway.

7. Betätigen Sie die Schaltfläche Speichern, um die Zuweisungsvorlage zu speichern.

So fügen Sie eine Methode und eine Integrationsantwort aus der POST-Methode hinzu

AWS CloudFormation hat eine leere Methode und eine leere Integrationsantwort erstellt. Sie werden diese Antwort bearbeiten, um weitere Informationen bereitzustellen. Weitere Informationen zum Bearbeiten von Antworten finden Sie unter Daten-Mapping-Referenz für Amazon API Gateway-API-Anfragen und Antworten.

1. Klicken Sie auf der Registerkarte Integrationsantwort unter Standard - Antwort auf Bearbeiten.

2. Wählen Sie Zuordnungsvorlagen aus und klicken Sie dann auf Zuordnungsvorlage hinzufügen.

3. Geben Sie für Inhaltstyp application/json ein.

4. Geben Sie im Code-Editor die folgende Ausgabe–Zuweisungsvorlage ein, um eine Ausgabenachricht zu senden:

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

   Weitere Informationen zu Kontextvariablen finden Sie unter  $context Variablen für Datenmodelle, Genehmiger, Mapping-Vorlagen und die CloudWatch-Zugriffsprotokolle.

5. Betätigen Sie die Schaltfläche Speichern, um die Zuweisungsvorlage zu speichern.

Testen der POST-Methode

Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.

1. Geben Sie im Anforderungstext das folgende Beispiel ein.

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

2. Wählen Sie Test aus.

   Die Ausgabe sollte Ihre Erfolgsmeldung enthalten.

   Sie können die DynamoDB-Konsole unter https://console.aws.amazon.com/dynamodb/ öffnen, um zu überprüfen, ob sich das Beispielelement in Ihrer Tabelle befindet.

So löschen Sie einen AWS CloudFormation-Stack

1. Öffnen Sie die AWS CloudFormation-Konsole unter https://console.aws.amazon.com/cloudformation.

2. Wählen Sie Ihren AWS CloudFormation-Stack aus.

3. Wählen Sie Löschen und bestätigen Sie dann Ihre Auswahl.

So erstellen Sie einen AWS CloudFormation-Stack

Laden Sie die Vorlage für die App-Erstellung für AWS CloudFormation herunter und entzippen Sie diese.

Um die folgenden Schritte durchzuführen, benötigen Sie die AWS Command Line Interface (AWS CLI) Version 2.

Bei langen Befehlen wird ein Escape-Zeichen (\) verwendet, um einen Befehl auf mehrere Zeilen aufzuteilen.

1. Verwenden Sie den folgenden Befehl, um den AWS CloudFormation-Stack zu erstellen.

   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 stellt die in der Vorlage angegebenen Ressourcen bereit. Die Bereitstellung der Ressourcen kann einige Minuten dauern. Sie können den folgenden Befehl verwenden, um den Status Ihres AWS CloudFormation-Stacks anzuzeigen.

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

3. Wenn der Status Ihres AWS CloudFormation-Stacks StackStatus: "CREATE_COMPLETE" ist, verwenden Sie den folgenden Befehl, um relevante Ausgabewerte für zukünftige Schritte abzurufen.

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

   Die Ausgabewerte sind die folgenden:

   • ApiRole, dies ist der Rollenname, der es API Gateway ermöglicht, Elemente in die DynamoDB-Tabelle einzufügen. Für dieses Tutorial ist der Rollenname data-transformation-tutorial-cli-APIGatewayRole-ABCDEFG.

   • DDBTableName, dies ist der Name der DynamoDB-Tabelle. Für dieses Tutorial ist der Name der Tabelle data-transformation-tutorial-cli-ddb.

   • ResourceId, dies ist die ID der Ressource für Haustiere, in der die Methoden GET und POST verfügbar sind. Für dieses Tutorial lautet die Ressourcen-ID efg456.

   • ApiId, dies ist die ID für die API. Für dieses Tutorial lautet die API-ID abc123.

So testen Sie die GET-Methode vor der Datentransformation

• Geben Sie den folgenden Befehl ein, um die GET-Methode zu testen.

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

  Die Ausgabe des Tests wird Folgendes zeigen.

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

  Sie transformieren diese Ausgabe gemäß der Zuweisungsvorlage in PetStore-Zuweisungsvorlage.

So transformieren Sie die GET-Integrationsantwort

• Führen Sie den folgenden Befehl aus, um die Integrationsantwort für die GET-Methode zu aktualisieren. Ersetzen Sie die rest-api-id und die resource-id durch Ihre Werte.

  Verwenden Sie den folgenden Befehl, um die Integrationsantwort zu erstellen.

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

So testen Sie die GET-Methode

• Geben Sie den folgenden Befehl ein, um die GET-Methode zu testen.

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

  Die Ausgabe des Tests zeigt die transformierte Antwort.

  [
    {
      "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
    }
  ]

So erstellen Sie eine POST-Methode

1. Führen Sie den folgenden Befehl aus, um eine neue Methode für die /pets-Ressource zu erstellen.

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

   Mit dieser Methode können Sie Haustierinformationen an die DynamoDB-Tabelle senden, die Sie im AWS CloudFormation-Stack erstellt haben.

2. Verwenden Sie den folgenden Befehl, um eine AWS-Service-Integration für die POST-Methode zu erstellen.

   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. Verwenden Sie den folgenden Befehl, um eine Methodenantwort für einen erfolgreichen Aufruf der POST-Methode zu erstellen.

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

4. Verwenden Sie den folgenden Befehl, um eine Integrationsantwort für den erfolgreichen Aufruf der POST-Methode zu erstellen.

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

So testen Sie die POST-Methode

• Geben Sie den folgenden Befehl ein, um die POST-Methode zu testen.

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

  In der Ausgabe wird die Erfolgsmeldung angezeigt.

So löschen Sie einen AWS CloudFormation-Stack

• Verwenden Sie den folgenden Befehl, um Ihre AWS CloudFormation-Ressourcen zu löschen.

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