Richten Sie mit der API Gateway-Konsole eine Methode ein

Wählen Sie im Bereich Ressourcen Ihre Methode und dann die Registerkarte Methodenanfrage aus.

Wählen Sie im Abschnitt Method request settings (Einstellungen der Methodenanforderung) die Option Edit (Bearbeiten) aus.

Wählen Sie für Authorization (Autorisierung) einen verfügbaren Genehmiger aus.

1. Um einen offenen Zugriff auf die Methode für alle Benutzer zu aktivieren, wählen Sie None (Keine) aus. Dieser Schritt kann übersprungen werden, wenn die Standardeinstellung nicht geändert wurde.

2. Um mithilfe von IAM Berechtigungen den Client-Zugriff auf die Methode zu steuern, wählen SieAWS_IAM. Bei dieser Auswahl dürfen nur Benutzer der IAM Rollen, denen die richtige IAM Richtlinie zugewiesen ist, diese Methode aufrufen.

   Um die IAM Rolle zu erstellen, geben Sie eine Zugriffsrichtlinie mit einem Format wie dem folgenden an:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": [
           "execute-api:Invoke"
         ],
         "Resource": [
           "resource-statement"
         ]
       }
     ]
   }  

   In dieser Zugriffsrichtlinie resource-statement ist die ARN Ihrer Methode. Sie finden die Methode ARN Ihrer Methode, indem Sie die Methode auf der Seite Ressourcen auswählen. Weitere Informationen zum Einstellen der IAM Berechtigungen finden Sie unterSteuern Sie den Zugriff auf eine REST API mit IAM Berechtigungen.

   Um die IAM Rolle zu erstellen, können Sie die Anweisungen im folgenden Tutorial anpassenLambda-Funktion für die Nicht-Proxy-Integration von Lambda erstellen.

3. Um einen Lambda-Genehmiger zu verwenden, wählen Sie ein Token oder einen Genehmiger der Anforderung aus. Erstellen Sie einen Lambda-Genehmiger, damit diese Auswahl im Dropdown-Menü angezeigt wird. Informationen über die Erstellung eines Lambda-Genehmigers finden Sie unter Verwenden Sie API Gateway Lambda-Autorisierer.

4. Um einen Amazon Cognito-Benutzerpool zu verwenden, wählen Sie einen verfügbaren Benutzerpool unter Cognito user pool authorizers (Cognito-Benutzerpool-Genehmiger) aus. Erstellen Sie einen Benutzerpool in Amazon Cognito und einen Amazon Cognito Cognito-Benutzerpool-Authorizer in API Gateway, damit diese Auswahl im Dropdownmenü angezeigt wird. Informationen darüber, wie Sie einen Amazon Cognito-Benutzerpool-Genehmiger erstellen, finden Sie unter Steuern Sie den Zugriff auf REST-APIs mithilfe von Amazon Cognito Cognito-Benutzerpools als Autorisierer.

Um die Anforderungsvalidierung anzugeben, wählen Sie einen Wert aus dem Dropdown-Menü Request Validator (Anforderungs-Validator) aus. Um die Anforderungsvalidierung zu deaktivieren, wählen Sie None (Keine) aus. Weitere Informationen zu den jeweiligen Optionen finden Sie unter Validierung für REST APIs in API Gateway anfordern.

Wählen Sie den erforderlichen API Schlüssel aus, um einen Schlüssel anzufordern. API Wenn diese Option aktiviert ist, werden API Schlüssel in Nutzungsplänen verwendet, um den Client-Verkehr zu drosseln.

(Optional) Um diesem, von API Gateway generiertenAPI, Operationsnamen in einem Java SDK zuzuweisen, geben Sie unter Operationsname einen Namen ein. Für die Methodenanforderung von GET /pets/{petId} lautet der entsprechende SDK Java-Operationsname beispielsweise standardmäßigGetPetsPetId. Dieser Name setzt sich aus dem HTTP Verb (GET) der Methode und den Variablennamen (PetsundPetId) für den Ressourcenpfad zusammen. Wenn Sie den Operationsnamen auf setzengetPetById, wird der SDK Operationsname zuGetPetById.

Fügen Sie der Methode wie folgt einen Abfragezeichenfolge-Parameter hinzu:

1. Wählen Sie Parameter für die URL Abfragezeichenfolge und anschließend die Option Abfragezeichenfolge hinzufügen aus.

2. Geben Sie unter Name den Namen des Abfragezeichenfolge-Parameters ein.

3. Wenn der neu erstellte Abfragezeichenfolge-Parameter für die Anforderungsvalidierung verwendet wird, wählen Sie die Option Required (Obligatorisch) aus. Weitere Informationen zur Anforderungsvalidierung finden Sie unter Validierung für REST APIs in API Gateway anfordern.

4. Wenn der neu erstellte Abfragezeichenfolge-Parameter als Teil eines Caching-Schlüssels verwendet wird, wählen Sie die Option Caching aus. Weitere Informationen zum Caching finden Sie unter Verwenden der Methoden-/Integrationsparameter als Cache-Schlüssel, um zwischengespeicherte Antworten zu indizieren.

Klicken Sie zum Entfernen des Abfragezeichenfolge-Parameters auf Remove (Entfernen).

Fügen Sie der Methode wie folgt einen Header-Parameter hinzu:

1. Wählen Sie „HTTPAnforderungsheader“ und anschließend „Kopfzeile hinzufügen“.

2. Geben Sie unter Name den Namen des Headers ein.

3. Wenn der neu erstellte Header für die Anforderungsvalidierung verwendet wird, wählen Sie die Option Required (Obligatorisch) aus. Weitere Informationen zur Anforderungsvalidierung finden Sie unter Validierung für REST APIs in API Gateway anfordern.

4. Wenn der neu erstellte Hader als Teil eines Caching-Schlüssels verwendet wird, wählen Sie die Option Caching aus. Weitere Informationen zum Caching finden Sie unter Verwenden der Methoden-/Integrationsparameter als Cache-Schlüssel, um zwischengespeicherte Antworten zu indizieren.

Um de Header zu entfernen, wählen Sie Remove (Entfernen).

Um das Payload-Format einer Methodenanforderung mit dem PATCH HTTP VerbPOST, oder zu deklarierenPUT, wählen Sie Request body und gehen Sie wie folgt vor:

1. Wählen Sie Add model aus.

2. Geben Sie als Inhaltstyp einen MIME -type ein (z. B.). application/json

3. Wählen Sie für Modell ein Modell aus dem Dropdown-Menü aus. Zu den derzeit verfügbaren Modellen für API gehören die Error Standardmodelle Empty und Modelle sowie alle Modelle, die Sie erstellt und der Models-Auflistung von hinzugefügt haben. API Weitere Informationen zum Erstellen eines Modells finden Sie unter Datenmodelle für REST APIs.

   Anmerkung

   Das Modell ist nützlich, um den Client über das erwartete Datenformat einer Nutzlast zu informieren. Es ist hilfreich, ein Mapping-Vorlagenskelett zu generieren. Es ist wichtig, eine stark typisierte Version SDK von API in Sprachen wie Java, C#, Objective-C und Swift zu generieren. Es ist nur erforderlich, wenn die Anforderungsvalidierung für die Nutzlast aktiviert ist.

Wählen Sie Save (Speichern) aus.

Wählen Sie im Bereich Ressourcen Ihre Methode und dann die Registerkarte Methodenantwort aus. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.

Wählen Sie im Abschnitt Method response settings (Einstellungen für Methodenantwort) die Option Create response (Antwort erstellen) aus.

Geben Sie als HTTPStatuscode einen HTTP Statuscode wie 200400, oder ein500.

Wenn für eine vom Backend zurückgegebene Antwort keine entsprechende Methodenantwort definiert ist, kann API Gateway die Antwort nicht an den Client zurücksenden. Stattdessen gibt es eine 500 Internal server error-Fehlerantwort zurück.

Wählen Sie Add header.

Geben Sie unter Header name (Header-Name) den Namen ein.

Um einen Header vom Backend an den Client zurückzugeben, fügen Sie den Header in die Methodenantwort ein.

Wählen Sie Add model (Modell hinzufügen), um ein Format für den Textkörpers der Methodenantwort zu definieren.

Geben Sie den Medientyp der Antwortnutzlast für Content type (Inhaltstyp) ein und wählen Sie ein Modell aus dem Dropdown-Menü Models (Modelle) aus.

Wählen Sie Save (Speichern) aus.