RESTAPIsIn API Gateway entwickeln

In Amazon API Gateway erstellen Sie eine REST API Sammlung programmierbarer Entitäten, die als API Gateway-Ressourcen bezeichnet werden. Beispielsweise verwenden Sie eine Ressource, um eine RestApiRessource darzustellenAPI, die eine Sammlung von Ressourcenentitäten enthalten kann.

Jede Resource Entität kann über eine oder mehrere Methodenressourcen verfügen. A Method ist eine eingehende Anfrage, die vom Client eingereicht wird und in den Anforderungsparametern und dem Text ausgedrückt wird. Es definiert die Anwendungsprogrammierschnittstelle, über die der Client auf die exponierten Dateien zugreifen kannResource. Um den Method in einen Backend-Endpunkt, der auch als Integrationsendpunkt bezeichnet wird, zu integrieren, erstellen Sie eine Integrationsressource. Dadurch wird die eingehende Anfrage an einen angegebenen Integrationsendpunkt weitergeleitet. URI Bei Bedarf können Sie die Anforderungsparameter oder den Anforderungstext transformieren, um die Backend-Anforderungen zu erfüllen.

Für Antworten können Sie eine MethodResponseRessource erstellen, die eine vom Client empfangene Anforderungsantwort darstellt, und Sie können eine IntegrationResponseRessource erstellen, die die vom Backend zurückgegebene Anforderungsantwort darstellt. Sie können die Integrationsantwort konfigurieren, um die Backend-Antwortdaten zu transformieren, bevor die Daten an den Client zurückgegeben werden, oder um die Backend-Antwort unverändert an den Client zu übermitteln.

Damit Ihre Kunden Ihre Informationen besser verstehenAPI, können Sie auch die Dokumentation für dieAPI, als Teil der API Erstellung oder nach der API Erstellung bereitstellen. Um dies zu aktivieren, fügen Sie eine DocumentationPartRessource für eine unterstützte API Entität hinzu.

Um zu steuern, wie Clients einen aufrufenAPI, verwenden Sie IAMBerechtigungen, einen Lambda-Autorisierer oder einen Amazon Cognito Cognito-Benutzerpool. Um die Nutzung Ihres zu messenAPI, richten Sie Nutzungspläne ein, um Anfragen zu drosseln. API Sie können diese aktivieren, wenn Sie Ihre erstellen oder aktualisierenAPI.

Eine Einführung in die Erstellung eines API finden Sie unterTutorial: Erstellen Sie eine REST API mit einer Lambda-Proxyintegration. Weitere Informationen zu den Funktionen von API Gateway, die Sie möglicherweise bei der Entwicklung eines verwenden RESTAPI, finden Sie in den folgenden Themen. Diese Themen enthalten grundlegende Informationen und Verfahren, die Sie mit der API Gateway-Konsole, dem API Gateway REST API AWS CLI, dem oder einem der folgenden ausführen können AWS SDKs.