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-Kennung, {region} die Region und {stage_name} der Stufenname der API-Bereitstellung ist.
Bevor Sie eine API aufrufen können, müssen Sie sie in API Gateway bereitstellen. Befolgen Sie hierzu die Anweisungen unter Bereitstellen einer REST-API in Amazon API Gateway.
Themen
Aufruf-URL einer API in der API Gateway-Konsole abrufen
Die Root-URL einer REST-API finden Sie im Stufeneditor für die API in der API Gateway-Konsole. Sie ist oben als Invoke URL aufgeführt. Wenn die Stammressource der API eine GET-Methode bereitstellt, ohne dass die Benutzerauthentifizierung erforderlich ist, können Sie die Methode aufrufen, indem Sie auf den Link Invoke URL klicken. Sie können diese Stamm-URL auch zusammensetzen, indem Sie die Felder host und basePath einer exportierten OpenAPI-Definitionsdatei der API kombinieren.
Wenn eine API den anonymen Zugriff gestattet, können Sie jeden Webbrowser verwenden, um beliebige GET-Methodenaufrufe auszuführen, indem Sie eine entsprechende Aufruf-URL kopieren und in die Adresszeile des Browsers einfügen. Bei anderen Methoden oder Aufrufen, für die eine Authentifizierung erforderlich ist, ist das Aufrufen komplexer, da Sie eine Nutzlast angeben oder die Anforderungen signieren müssen. Sie können diese mithilfe eines der AWS-SDKs in einem Skript hinter einer HTML-Seite oder in einer Client-Anwendung verarbeiten.
Zum Testen können Sie die API Gateway-Konsole verwenden, um eine API über die TestInvoke-Funktion des API Gateways aufzurufen, wobei die Invoke-URL umgangen wird. Dies ermöglicht API-Tests, bevor die API bereitgestellt wird. Alternativ können Sie die Postman
In Parameterwerten für Abfragezeichenfolgen in einer Aufruf-URL ist %% nicht zulässig.
