Rufen Sie REST-APIs im API Gateway auf

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-ID, region die AWS Region und stage der Phasenname der API-Bereitstellung ist.

Wichtig

Bevor Sie eine API aufrufen können, müssen Sie sie in API Gateway bereitstellen. Anweisungen zur Bereitstellung einer API finden Sie unter. RESTAPIsIn API Gateway bereitstellen

Themen

• Abrufen der Aufruf-URL einer API
• 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
• Verwenden Sie ein von API Gateway JavaScript SDK generiertes für ein REST API
• Verwenden Sie einen von API Gateway SDK generierten Ruby für ein REST API
• Von API Gateway generiertes iOS-SDK für eine REST-API in Objective-C oder Swift verwenden

Abrufen der Aufruf-URL einer API

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

Die Aufruf-URL einer API mithilfe der Konsole abrufen

Das folgende Verfahren zeigt, wie Sie die Aufruf-URL einer API in der REST-API-Konsole abrufen.

So rufen Sie die Aufruf-URL einer API mithilfe der REST-API-Konsole ab

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. Um die Aufruf-URL einer API für eine andere Ressource in Ihrer API abzurufen, erweitern Sie die Stufe unter dem sekundären Navigationsbereich und wählen Sie dann eine Methode aus.

6. Wählen Sie das Symbol „Kopieren“, um die Aufruf-URL Ihrer API auf Ressourcenebene zu kopieren.

   

Abrufen der Aufruf-URL einer API mithilfe von AWS CLI

Das folgende Verfahren zeigt, wie Sie die Aufruf-URL einer API mithilfe von abrufen. AWS CLI

Um die Aufruf-URL einer API mit dem abzurufen AWS CLI

1. Verwenden Sie den folgenden Befehl, um die zu erhalten. rest-api-id 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. Ersetze das Beispiel rest-api-id durch deinrest-api-id, ersetze das Beispiel {stage-name} durch deinen {stage-name} und ersetze {region} durch deine 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 Stamm-URL auch erstellen, indem Sie die basePath Felder host und einer exportierten OpenAPI-Definitionsdatei der API kombinieren. Anweisungen zum Exportieren Ihrer API finden Sie unterRESTAPIAus API Gateway exportieren.

Aufrufen einer API

Sie können Ihre bereitgestellte API über den Browser, Curl oder andere Anwendungen wie Postman aufrufen.

Darüber hinaus können Sie die API Gateway Gateway-Konsole verwenden, um einen API-Aufruf zu testen. 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 anonymen Zugriff zulässt, können Sie einen beliebigen Webbrowser verwenden, um eine beliebige GET Methode aufzurufen. Geben Sie die vollständige Aufruf-URL in die Adressleiste des Browsers ein.

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

Eine API mit curl aufrufen

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 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"