Grundlegende Anforderungsvalidierung in API Gateway einrichten

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 request-validation-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 wählen Sie Ihre neu erstellte API aus

1. Wählen Sie den neu erstellten request-validation-tutorial-console-Stack aus.

2. Wählen Sie Resources aus.

3. Wählen Sie unter Physische ID Ihre API aus. Dieser Link leitet Sie zur API-Gateway-Konsole weiter.

So erstellen Sie ein Modell

1. Ein Modell ist erforderlich, um die Anforderungsvalidierung für den Text einer eingehenden Anfrage zu verwenden. Klicken Sie im Hauptnavigationsbereich auf Modelle, um ein Modell zu erstellen.

2. Wählen Sie Modell erstellen aus.

3. Geben Sie unter Name PetStoreModel ein.

4. Geben Sie für Inhaltstyp application/json ein. Wenn kein passender Inhaltstyp gefunden wird, wird die Anforderungsvalidierung nicht durchgeführt. Geben Sie $default ein, um das gleiche Modell unabhängig vom Inhaltstyp zu verwenden.

5. Geben Sie für Beschreibung My PetStore Model als die Modellbeschreibung ein.

6. Für Modellschema kopieren Sie das folgende Modell in den Code-Editor ein und klicken dann auf Modell erstellen.

   {
     "type" : "object",
     "required" : [ "name", "price", "type" ],
     "properties" : {
       "id" : {
         "type" : "integer"
       },
       "type" : {
         "type" : "string",
         "enum" : [ "dog", "cat", "fish" ]
       },
       "name" : {
         "type" : "string"
       },
       "price" : {
         "type" : "number",
         "minimum" : 25.0,
         "maximum" : 500.0
       }
     }
   }

Konfigurieren einer Anforderungsvalidierung für eine GET-Methode

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

2. Wählen Sie auf der Registerkarte Methodenanfrage unter Methodenanfrage-Einstellungen die Option Bearbeiten aus.

3. Wählen Sie für Anforderungs-Validierer die Option Abfragezeichenfolgeparameter und -Header validieren aus.

4. Wählen Sie URL-Abfragezeichenfolgen-Parameter aus und gehen Sie dann wie folgt vor:

   1. Wählen Sie Abfragezeichenfolge hinzufügen aus.

   2. Geben Sie unter Name petType ein.

   3. Aktivieren Sie die Option Erforderlich.

   4. Caching bleibt ausgeschaltet.

5. Wählen Sie Save (Speichern) aus.

6. Klicken Sie auf der Registerkarte Integrationsanfrage unter Einstellungen für Integrationsanfragen auf Bearbeiten.

7. Wählen Sie URL-Abfragezeichenfolgen-Parameter aus und gehen Sie dann wie folgt vor:

   1. Wählen Sie Abfragezeichenfolge hinzufügen aus.

   2. Geben Sie unter Name petType ein.

   3. Geben Sie für Zugeordnet von method.request.querystring.petType ein. Dadurch wird petType dem Typ des Haustiers zugeordnet.

      Weitere Informationen zur Datenzuordnung finden Sie im Tutorial zur Datenzuordnung.

   4. Caching bleibt ausgeschaltet.

8. Wählen Sie Save (Speichern) aus.

So testen Sie die Anforderungsvalidierung für die GET-Methode

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

2. Für Abfragezeichenfolgen geben Sie petType=dog ein und klicken dann auf Test.

3. Der Methodentest gibt 200 OK und eine Liste von Hunden zurück.

   Informationen zur Umwandlung dieser Ausgabedaten finden Sie im Tutorial zur Datenzuordnung.

4. Entfernen Sie petType=dog und wählen Sie Test aus.

5. Der Methodentest gibt einen 400-Fehler mit der folgenden Fehlermeldung zurück:

   {
     "message": "Missing required request parameters: [petType]"
   }

Konfigurieren der Anforderungsvalidierung für die POST-Methode

1. Klicken Sie im Hauptnavigationsbereich auf Ressourcen und wählen Sie dann die POST-Methode aus.

2. Wählen Sie auf der Registerkarte Methodenanfrage unter Methodenanfrage-Einstellungen die Option Bearbeiten aus.

3. Für Anforderungs-Validator wählen Sie die Option Text validieren aus.

4. Klicken Sie unter Anforderungstext auf Modell hinzufügen.

5. Geben Sie für Content type (Inhaltstyp) application/json ein. Wenn kein passender Inhaltstyp gefunden wird, wird die Anforderungsvalidierung nicht durchgeführt. Geben Sie $default ein, um das gleiche Modell unabhängig vom Inhaltstyp zu verwenden.

   Wählen Sie unter Modell die Option PetStoreModel aus.

6. Wählen Sie Save (Speichern) aus.

Testen der Anforderungsvalidierung für eine POST-Methode

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

2. Für Anforderungstext kopieren Sie Folgendes in den Code-Editor:

   {
     "id": 2,
     "name": "Bella",
     "type": "dog",
     "price": 400
   }

   Wählen Sie Test aus.

3. Der Methodentest gibt 200 OK und eine Erfolgsmeldung zurück.

4. Für Anforderungstext kopieren Sie Folgendes in den Code-Editor:

   {
     "id": 2,
     "name": "Bella",
     "type": "dog",
     "price": 4000
   }

   Wählen Sie Test aus.

5. Der Methodentest gibt einen 400-Fehler mit der folgenden Fehlermeldung zurück:

   {
    "message": "Invalid request body"
   }

   Der Grund für den ungültigen Anforderungstext wird ganz unten in den Testprotokollen angegeben. In diesem Fall lag der Preis des Haustiers außerhalb des im Modell angegebenen Höchstpreises.

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 request-validation-tutorial-cli --template-body file://request-validation-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 request-validation-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 request-validation-tutorial-cli --query "Stacks[*].Outputs[*].{OutputKey: OutputKey, OutputValue: OutputValue, Description: Description}"

   Die Ausgabewerte sind die folgenden:

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

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

So erstellen Sie die Anforderungsvalidierungen und importieren ein Modell

1. Ein Validator ist erforderlich, um die Anforderungsvalidierung mit der AWS CLI zu verwenden. Verwenden Sie den folgenden Befehl, um einen Validator zu erstellen, der nur Anforderungsparameter validiert.

   aws apigateway create-request-validator --rest-api-id abc123 \
         --no-validate-request-body \
         --validate-request-parameters \
         --name params-only

   Notieren Sie sich die ID des params-only-Validators.

2. Verwenden Sie den folgenden Befehl, um einen Validator zu erstellen, der nur den Anforderungstext validiert.

   aws apigateway create-request-validator --rest-api-id abc123 \
         --validate-request-body \
         --no-validate-request-parameters \
         --name body-only

   Notieren Sie sich die ID des body-only-Validators.

3. Ein Modell ist erforderlich, um die Anforderungsvalidierung für den Text einer eingehenden Anfrage zu verwenden. Verwenden Sie den folgenden Befehl, um ein Modell zu importieren.

   aws apigateway create-model --rest-api-id abc123 --name PetStoreModel --description 'My PetStore Model' --content-type 'application/json' --schema '{"type": "object", "required" : [ "name", "price", "type" ], "properties" : { "id" : {"type" : "integer"},"type" : {"type" : "string", "enum" : [ "dog", "cat", "fish" ]},"name" : { "type" : "string"},"price" : {"type" : "number","minimum" : 25.0, "maximum" : 500.0}}}}' 

   Wenn kein passender Inhaltstyp gefunden wird, wird die Anforderungsvalidierung nicht durchgeführt. Um das gleiche Modell unabhängig vom Inhaltstyp zu verwenden, geben Sie es $default als Schlüssel an.

So erstellen Sie die Methoden GET und POST

1. Rufen Sie den folgenden Befehl auf, um die GET-HTTP-Methode der /validate-Ressource hinzuzufügen. Dieser Befehl erstellt die GET-Methode, fügt den params-only-Validator hinzu und legt die Abfragezeichenfolge petType nach Bedarf fest.

   aws apigateway put-method --rest-api-id abc123 \
          --resource-id efg456 \
          --http-method GET \
          --authorization-type "NONE" \
          --request-validator-id aaa111 \
          --request-parameters "method.request.querystring.petType=true"

   Rufen Sie den folgenden Befehl auf, um die POST-HTTP-Methode der /validate-Ressource hinzuzufügen. Mit diesem Befehl wird die POST-Methode erstellt, der body-only-Validator hinzugefügt und das Modell an den Validator angehängt, der nur für den Text gilt.

   aws apigateway put-method --rest-api-id abc123 \
          --resource-id efg456 \
          --http-method POST \
          --authorization-type "NONE" \
          --request-validator-id bbb222 \
          --request-models 'application/json'=PetStoreModel

2. Führen Sie den folgenden Befehl aus, um die 200 OK-Antwort der GET /validate-Methode einzurichten.

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

   Führen Sie den folgenden Befehl aus, um die 200 OK-Antwort der POST /validate-Methode einzurichten.

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

3. Führen Sie den folgenden Befehl aus, um einen Integration mit einem angegebenen HTTP-Endpunkt für die GET /validation-Methode einzurichten.

   aws apigateway put-integration --rest-api-id abc123  \
               --resource-id efg456 \
               --http-method GET \
               --type HTTP \
               --integration-http-method GET \
               --request-parameters '{"integration.request.querystring.type" : "method.request.querystring.petType"}' \
               --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'

   Führen Sie den folgenden Befehl aus, um einen Integration mit einem angegebenen HTTP-Endpunkt für die POST /validation-Methode einzurichten.

   aws apigateway put-integration --rest-api-id abc123  \
                 --resource-id efg456 \
                 --http-method POST \
                 --type HTTP \
                 --integration-http-method GET \
                 --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'

4. Führen Sie den folgenden Befehl aus, um die Integration der GET /validation-Methode einzurichten.

   aws apigateway put-integration-response --rest-api-id abc123 \
                 --resource-id efg456\
                 --http-method GET \
                 --status-code 200 \
                 --selection-pattern ""

   Führen Sie den folgenden Befehl aus, um die Integration der POST /validation-Methode einzurichten.

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

So testen Sie die API-Daten

1. Verwenden Sie den folgenden Befehl, um die GET-Methode zu testen, die eine Anforderungsvalidierung für die Abfragezeichenfolgen durchführt:

   aws apigateway test-invoke-method --rest-api-id abc123 \
               --resource-id efg456 \
               --http-method GET \
               --path-with-query-string '/validate?petType=dog'

   Das Ergebnis gibt 200 OK und eine Liste von Hunden zurück.

2. Verwenden Sie den folgenden Befehl, um zu testen, ohne die Abfragezeichenfolge petType einzuschließen.

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

   Das Ergebnis gibt einen 400-Fehler zurück.

3. Verwenden Sie den folgenden Befehl, um die POST-Methode zu testen, die eine Anforderungsvalidierung für den Anforderungstext durchführt:

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

   Das Ergebnis gibt 200 OK und eine Erfolgsmeldung zurück.

4. Verwenden Sie den folgenden Befehl, um mit einem ungültigen Text zu testen.

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

   Das Ergebnis gibt einen 400-Fehler zurück, da der Preis des Hundes über dem vom Modell festgelegten Höchstpreis liegt.

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 request-validation-tutorial-cli