Aufrufen von REST-APIs in API Gateway

Um eine bereitgestellte API aufzurufen, senden Kunden Anfragen an die URL für den API Gateway-Komponenten-Service zur API-Ausführung (bekannt als execute-api).

Die Basis-URL für REST-API liegt im folgenden Format vor:

https://api-id.execute-api.region.amazonaws.com/stage/

wobei api-id die API-Kennung, region die AWS-Region und stage der Stufenname der API-Bereitstellung ist.

Wichtig

Bevor Sie eine API aufrufen können, müssen Sie sie in API Gateway bereitstellen. Anleitungen zur Bereitstellung einer API finden Sie unter REST-APIs in API Gateway bereitstellen.

Themen

• Die Aufruf-URL einer API abrufen
• Aufrufen einer API
• API Gateway-Konsole zum Testen einer REST-API-Methode verwenden
• Von API Gateway generiertes Java-SDK für eine REST-API verwenden
• Ein von API Gateway generiertes Android-SDK für eine REST-API verwenden
• Ein von API Gateway generiertes JavaScript-SDK für eine REST-API verwenden
• Ein von API Gateway generiertes Ruby-SDK für eine REST-API verwenden
• Von API Gateway generiertes iOS-SDK für eine REST-API in Objective-C oder Swift verwenden

Die Aufruf-URL einer API abrufen

Sie können die Konsole, AWS CLI oder eine exportierte OpenAPI-Definition verwenden, um die Aufruf-URL einer API abzurufen.

Die Aufruf-URL einer API in der Konsole abrufen

Im folgenden Verfahren wird gezeigt, wie Sie die Aufruf-URL einer API in der REST-API-Konsole abrufen.

Abrufen der Aufruf-URL einer API in der REST-API-Konsole

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

2. Wählen Sie eine bereitgestellte API aus.

3. Wählen Sie im Haupt-Navigationsbereich Stufe aus.

4. Wählen Sie unter Stufendetails das Kopiersymbol aus, um die Aufruf-URL Ihrer API zu kopieren.

   Diese URL ist für die Root-Ressource Ihrer API.

   

5. Vergrößern Sie die Stufe im sekundären Navigationsbereich und wählen Sie dann eine Methode aus, um die Aufruf-URL einer API für eine andere Ressource in Ihrer API abzurufen.

6. Klicken Sie auf das Kopiersymbol, um die Aufruf-URL Ihrer API auf Ressourcenebene zu kopieren.

   

Aufruf-URL einer API mithilfe der AWS CLI abrufen

Im folgenden Verfahren wird gezeigt, wie Sie die Aufruf-URL einer API mithilfe der AWS CLI abrufen.

Aufruf-URL einer API mithilfe der AWS CLI abrufen

1. Rufen Sie die rest-api-id mit folgendem Befehl ab. Dieser Befehl gibt alle rest-api-id-Werte in Ihrer Region zurück. Weitere Informationen finden Sie unter get-rest-apis.

   aws apigateway get-rest-apis

2. Ersetzen Sie die Beispiel-rest-api-id durch Ihre rest-api-id, den Beispiel-{stage-name} durch Ihren {stage-name} und die {region} durch Ihre Region.

   https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/

Abrufen der Aufruf-URL einer API mithilfe der exportierten OpenAPI-Definitionsdatei der API

Sie können die Root-URL auch zusammensetzen, indem Sie die Felder host und basePath einer exportierten OpenAPI-Definitionsdatei der API kombinieren. Eine Anleitung zum Exportieren Ihrer API finden Sie unter REST-API von API Gateway importieren.

Aufrufen einer API

Sie können Ihre bereitgestellte API im Browser, mit Curl oder anderen Anwendungen wie Postman aufrufen.

Darüber hinaus können Sie einen API-Aufruf mithilfe der API-Gateway-Konsole testen. Der Test verwendet die TestInvoke-Funktion des API-Gateways, die API-Tests vor der Bereitstellung der API ermöglicht. Weitere Informationen finden Sie unter API Gateway-Konsole zum Testen einer REST-API-Methode verwenden.

Anmerkung

In Parameterwerten für Abfragezeichenfolgen in einer Aufruf-URL ist %% nicht zulässig.

Aufrufen einer API mit einem Webbrowser

Wenn Ihre API anonyme Zugriffe gestattet, können Sie jeden Webbrowser verwenden, um eine beliebige GET-Methode aufzurufen. Geben Sie die vollständige Aufruf-URL in die Adressleiste des Browsers ein.

Bei anderen Methoden oder Aufrufen, für die eine Authentifizierung erforderlich ist, müssen Sie eine Nutzlast angeben oder die Anforderungen signieren. Sie können diese mithilfe eines der AWS-SDKs in einem Skript hinter einer HTML-Seite oder in einer Client-Anwendung verarbeiten.

Aufrufen einer API mit Curl

Sie können ein Tool wie Curl in Ihrem Terminal verwenden, um Ihre API aufzurufen. Der folgende CURL-Beispielbefehl ruft die GET-Methode für die getUsers-Ressource in der prod-Stufe einer API auf.

Linux or Macintosh

curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'

Windows

curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"