Tutorial: Ändern Sie die Integrationsanfrage und die Antwort für Integrationen zu AWS service

Um eine zu erstellen CloudFormation Stack

1. Öffnen Sie die 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 bei Capabilities, dass IAM-Ressourcen in Ihrem Konto erstellt werden CloudFormation können.

9. Wählen Sie Weiter und anschließend Absenden aus.

Um die Antwort der GET-Integration zu testen

1. Wählen Sie auf der Registerkarte Ressourcen des 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 Transformationen mit Zuweisungsvorlagen für REST-APIs in API Gateway.

Um die GET-Integrationsantwort zu transformieren

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 Speichern.

Um die GET-Integrationsantwort zu testen

• 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
    }
  ]

Um Eingabedaten aus der POST-Methode zu transformieren

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.

   Die CloudFormation Vorlage hat einige Felder für Integrationsanfragen gefüllt.

   • Der Integrationstyp ist AWS-Service.

   • Das AWS-Service ist DynamoDB.

   • Die HTTP-Methode ist POST.

   • Die Aktion ist PutItem.

   • Die Ausführungsrolle, die es API Gateway ermöglicht, ein Element in die DynamoDB-Tabelle aufzunehmen, lautet. data-transformation-tutorial-console-APIGatewayRole 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.

   Das bedeutet, dass die API Daten ablehnt, für Content-Types die es keine Zuordnungsvorlage gibt.

4. Wählen Sie Zuordnungsvorlagen aus.

5. Der Inhaltstyp ist auf application/json gesetzt. Das bedeutet, dass Inhaltstypen, die application/json dies nicht sind, von der API abgelehnt werden. Weitere Informationen zu Integrations-Passthrough-Verhaltensweisen finden Sie unter Verhalten der Methodenanforderung für Nutzdaten ohne Zuweisungsvorlagen für REST-APIs in API Gateway.

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 Validierung für REST APIs in API Gateway anfordern.

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

Um eine Methode und eine Integrationsantwort aus der POST-Methode hinzuzufügen

Sie CloudFormation haben 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 Beispiele für Parameterzuweisungen für REST-APIs in API Gateway.

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 unter Content-type den Wert 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  Kontextvariablen für Datentransformationen.

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

Testen Sie die 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 öffnen, https://console.aws.amazon.com/dynamodb/um zu überprüfen, ob sich das Beispielelement in Ihrer Tabelle befindet.

Um ein zu löschen CloudFormation Stack

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

2. Wählen Sie Ihren CloudFormation Stack aus.

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

Um eine zu erstellen CloudFormation Stack

Laden Sie die Vorlage zur App-Erstellung für CloudFormation herunter und entpacken Sie sie.

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 Stack zu erstellen. CloudFormation

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

2. CloudFormation stellt die in der Vorlage angegebenen Ressourcen bereit. Die Bereitstellung der Ressourcen kann einige Minuten dauern. Verwenden Sie den folgenden Befehl, um den Status Ihres CloudFormation Stacks zu überprüfen.

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

3. Wenn der Status Ihres CloudFormation Stacks lautetStackStatus: "CREATE_COMPLETE", verwenden Sie den folgenden Befehl, um relevante Ausgabewerte für future 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, das 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, das ist der Name der DynamoDB-Tabelle. Für dieses Tutorial ist der Name der Tabelle data-transformation-tutorial-cli-ddb.

   • ResourceId, das ist die ID der Pets-Ressource, in der die POST Methoden GET und verfügbar gemacht werden. Für dieses Tutorial lautet die Ressourcen-ID efg456.

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

Um die GET-Methode vor der Datentransformation zu testen

• 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 Transformationen mit Zuweisungsvorlagen für REST-APIs in API Gateway.

Um die GET-Integrationsantwort zu transformieren

• Führen Sie den folgenden Befehl aus, um die Integrationsantwort für die GET-Methode zu aktualisieren. Ersetzen Sie das rest-api-id und 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]"}'

Um die GET-Methode zu testen

• 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
    }
  ]

Um eine POST-Methode zu erstellen

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 Pet-Informationen an die DynamoDB-Tabelle senden, die Sie im Stack erstellt haben. CloudFormation

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

Um die POST-Methode zu testen

• 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.

Um ein zu löschen CloudFormation Stack

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

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