Tutorial: Erstellen Sie eine REST API mit einer HTTP Nicht-Proxy-Integration

Um eine zu erstellen API

1. Melden Sie sich bei der API Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Wenn Sie API Gateway zum ersten Mal verwenden, wird eine Seite angezeigt, auf der Sie mit den Funktionen des Dienstes vertraut gemacht werden. Wählen Sie RESTAPIunter Build aus. Wenn das API Popup-Fenster „Beispiel erstellen“ angezeigt wird, wählen Sie „OK“.

   Wenn Sie API Gateway nicht zum ersten Mal verwenden, wählen Sie Create API. Wählen Sie RESTAPIunter Build aus.

3. Geben Sie als APINamen einHTTPNonProxyAPI.

4. (Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.

5. Lassen Sie den APIEndpunkttyp auf Regional eingestellt.

6. Wählen Sie Erstellen ausAPI.

Erstellen einer /pets-Ressource

1. Wählen Sie Create Resource (Ressource erstellen) aus.

2. Die Proxy-Ressource bleibt ausgeschaltet.

3. Ressourcenpfad wird als / beibehalten.

4. Geben Sie für Resource name (Ressourcenname) pets ein.

5. Halten Sie CORS(Cross-Origin Resource Sharing) ausgeschaltet.

6. Wählen Sie Create Resource (Ressource erstellen) aus.

So erstellen Sie eine GET-Methode für die /pets-Ressource

1. Wählen Sie die /pets-Ressource aus.

2. Wählen Sie Methode erstellen aus.

3. Wählen Sie als Methodentyp die Option GET aus.

4. Wählen Sie als Integrationstyp die Option Integration aus. HTTP

5. Lassen Sie die HTTPProxyintegration ausgeschaltet.

6. Wählen Sie als HTTPMethode die Option aus GET.

7. Geben Sie für Endpunkt URL den Wert einhttp://petstore-demo-endpoint.execute-api.com/petstore/pets.

   Auf der PetStore Website können Sie auf einer bestimmten Seite eine Liste mit Pet Objekten abrufen, die nach Tierart sortiert sind, z. B. „Hund“ oder „Katze“.

8. Für Inhaltsbehandlung wählen Sie Passthrough aus.

9. Wählen Sie die Parameter für die URL Abfragezeichenfolge.

   Die PetStore Website verwendet die Parameter type und die page Abfragezeichenfolge, um eine Eingabe zu akzeptieren. Sie fügen der Methodenanforderung Abfragezeichenfolgenparameter hinzu und ordnen sie den entsprechenden Abfragezeichenfolgenparametern der Integrationsanforderung zu.

10. Gehen Sie wie folgt vor, um die Abfragezeichenfolgenparameter hinzuzufügen:

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

    2. Für Name geben Sie type ein.

    3. Lassen Sie die Optionen Required (Obligatorisch) and Caching (Cache) deaktiviert.

    Wiederholen Sie die obigen Schritte, um eine zusätzliche Abfragezeichenfolge namens page zu erstellen.

11. Wählen Sie Methode erstellen aus.

Zuordnen von Eingabeparametern zur Integrationsanforderung

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

2. Wählen Sie die Parameter für die URL Abfragezeichenfolge aus und gehen Sie dann wie folgt vor:

   1. Klicken Sie auf Abfragezeichenfolge-Parameter hinzufügen.

   2. Geben Sie unter Name type ein.

   3. Für Zugeordnet von geben Sie method.request.querystring.type ein.

   4. Caching bleibt ausgeschaltet.

   5. Klicken Sie auf Abfragezeichenfolge-Parameter hinzufügen.

   6. Geben Sie unter Name page ein.

   7. Für Zugeordnet von geben Sie method.request.querystring.page ein.

   8. Caching bleibt ausgeschaltet.

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

Um das zu testen API

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

2. Für Abfrage-Zeichenketten geben Sie type=Dog&page=2 ein.

3. Wählen Sie Test aus.

   Das Ergebnis sollte wie folgt aussehen:

   

   Jetzt, da der Test erfolgreich ist, können wir den bereitstellen, um ihn öffentlich API zugänglich zu machen.

4. Wählen Sie BereitstellenAPI aus.

5. Wählen Sie für Stufe die Option Neue Stufe aus.

6. Geben Sie für Stage name (Stufenname) Prod ein.

7. (Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.

8. Wählen Sie Bereitstellen.

9. (Optional) Unter Stage-Details können Sie für Invoke das Kopiersymbol auswählenURL, um Ihren API eigenen Aufruf URL zu kopieren. Sie können dies mit Tools wie Postman und c verwenden, um Ihre URL zu testen. API

Um die Ressource {petId} zu erstellen

1. Wählen Sie die /pets-Ressource aus und klicken Sie dann auf Ressource erstellen.

2. Die Proxy-Ressource bleibt ausgeschaltet.

3. Für Ressourcenpfad wählen Sie die Option/pets/aus.

4. Geben Sie für Resource name (Ressourcenname) {petId} ein.

   Verwenden Sie rundherum geschweifte Klammern ({ }), petId sodass /pets/ {} angezeigt wird. petId

5. Lassen Sie CORS(Cross Origin Resource Sharing) ausgeschaltet.

6. Wählen Sie Create Resource (Ressource erstellen) aus.

Um die GET Methode einzurichten

1. Wählen Sie die Ressource/{petId} aus und wählen Sie dann Methode erstellen aus.

2. Wählen Sie als Methodentyp die Option GET aus.

3. Wählen Sie als Integrationstyp die Option HTTPIntegration aus.

4. Lassen Sie die HTTPProxyintegration ausgeschaltet.

5. Wählen Sie als HTTPMethode die Option aus GET.

6. Geben Sie für Endpoint URL Folgendes ein http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}

7. Für Inhaltsbehandlung wählen Sie Passthrough aus.

8. Das Standard-Timeout bleibt aktiviert.

9. Wählen Sie Methode erstellen aus.

Zuordnen des {petId}-Pfadparameters

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

2. Wählen Sie URLPfadparameter.

3. APIGateway erstellt einen Pfadparameter für die Integrationsanfrage mit dem Namen petId. Dieser Pfadparameter ist jedoch nicht gültig für den HTTP EndpunktURL, den Sie als Backend-Integration festgelegt haben. Der HTTP Endpunkt verwendet {id} ihn als Pfadparameter. Löschen Sie das Feld Name petIdund geben Sie einid.

   Damit wird der Pfadparameter petId der Methodenanforderung dem Pfadparameter id der Integrationsanforderung zugewiesen.

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

So testen Sie die -Methode

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

2. Geben Sie unter Pfad für petIdden Wert ein4.

3. Wählen Sie Test aus.

   Wenn diese Aktion erfolgreich ist, zeigt Antworttext Folgendes an:

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }

So stellen Sie die API bereit

1. Wählen Sie BereitstellenAPI aus.

2. Für Stufe wählen Sie die Option Prod aus.

3. (Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.

4. Wählen Sie Bereitstellen.

1. Klicken Sie im Hauptnavigationsbereich auf Stufe.

2. Wählen Sie unter Stage-Details das Kopiersymbol aus, um Ihren API Aufruf zu kopieren. URL

   Sie sollte wie folgt aussehen:

   https://my-api-id.execute-api.region-id.amazonaws.com/prod

3. Geben Sie dies URL in das Adressfeld eines neuen Browser-Tabs ein und fügen Sie es /pets/4 an das an, URL bevor Sie Ihre Anfrage abschicken.

4. Der Browser gibt Folgendes zurück:

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }