Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
REST-API im Amazon API Gateway aufrufen
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://restapi_id.execute-api.region.amazonaws.com/stage_name/
wobei restapi_id die API-ID, Region die AWS Region und stage_name der Stufenname der API-Bereitstellung ist.
Wichtig
Bevor Sie eine API aufrufen können, müssen Sie sie in API Gateway bereitstellen. Anweisungen zum Bereitstellen einer API finden Sie unter Bereitstellen einer REST-API in Amazon API Gateway.
Themen
Abrufen der Aufruf-URL einer API
Sie können die Konsole, die oder eine exportierte OpenAPI-Definition verwenden AWS CLI, um die Aufruf-URL einer API abzurufen.
Abrufen der Aufruf-URL einer API mit der Konsole
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 mit der REST-API-Konsole ab
Melden Sie sich bei der API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway
an. Wählen Sie eine bereitgestellte API aus.
-
Wählen Sie im Haupt-Navigationsbereich Stufe aus.
-
Wählen Sie unter Stufendetails das Kopiersymbol aus, um die Aufruf-URL Ihrer API zu kopieren.
Diese URL bezieht sich auf die Stammressource Ihrer API.
Um die Aufruf-URL einer API für eine andere Ressource in Ihrer API abzurufen, erweitern Sie die Stufe im sekundären Navigationsbereich und wählen Sie dann eine Methode aus.
Wählen Sie das Kopiersymbol, um die Aufruf-URL Ihrer API auf Ressourcenebene zu kopieren.
Abrufen der Aufruf-URL einer API mit der AWS CLI
Das folgende Verfahren zeigt, wie Sie die Aufruf-URL einer API mithilfe der abrufen AWS CLI.
So rufen Sie die Aufruf-URL einer API mit der ab AWS CLI
Verwenden Sie den folgenden Befehl, um die abzurufen
rest-api-id. Dieser Befehl gibt allerest-api-idWerte in Ihrer Region zurück. Weitere Informationen finden Sie unter get-rest-apis.aws apigateway get-rest-apisErsetzen Sie das Beispiel
rest-api-iddurch Ihrrest-api-id, ersetzen Sie das Beispiel{stage-name}durch Ihr{stage-name}und ersetzen Sie {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 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 unter REST-API von API Gateway importieren.
Aufrufen einer API
Sie können Ihre bereitgestellte API über den Browser, curl oder andere Anwendungen wie Postman
Darüber hinaus können Sie die API Gateway-Konsole verwenden, um einen API-Aufruf zu testen. Test verwendet die API Gateway-TestInvokeFunktion, die API-Tests ermöglicht, bevor die API bereitgestellt wird. 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 über einen Webbrowser
Wenn Ihre API anonymen Zugriff zulässt, können Sie einen beliebigen Webbrowser verwenden, um eine beliebige GET Methode aufzurufen. Geben Sie die URL des vollständigen Aufrufs in die Adressleiste des Browsers ein.
Für andere Methoden oder alle für die Authentifizierung erforderlichen Aufrufe müssen Sie eine Nutzlast angeben oder die Anforderungen signieren. Sie können diese in einem Skript hinter einer HTML-Seite oder in einer Clientanwendung mithilfe eines der AWS SDKs verarbeiten.
Aufrufen einer API mit curl
Sie können ein Tool wie curlgetUsersRessource der -prodStufe einer API auf.
