Entwickeln einer REST-API in API Gateway

In Amazon API Gateway erstellen Sie eine REST-API als eine Sammlung programmierbarer Entitäten, die als API Gateway-Ressourcen bekannt ist. Beispiel: Sie können eine RestApi-Ressource verwenden, um eine API darzustellen, die eine Sammlung von Ressourcen-Entitäten enthalten kann.

Jede Resource-Entität kann über eine oder mehrere Methoden-Ressourcen verfügen. Eine Method ist eine eingehende Anforderung, die vom Client übermittelt wurde und in den Parametern und im Textkörper der Anforderung ausgedrückt wird. Sie definiert die Anwendungsprogrammierschnittstelle (API) für den Client-Zugriff auf die zugängliche Ressource. Erstellen Sie eine Ressource unter Integration, um die Method mit einem Backend-Endpunkt (auch als Integrationsendpunkt bekannt) zu integrieren. Dadurch wird die eingehende Anforderung an eine bestimmte Integrationsendpunkt-URI weitergeleitet. Falls erforderlich, können Sie die Anforderungsparameter oder den Textkörper der Anforderung transformieren, um die Anforderungen des Backend zu erfüllen.

Sie können eine MethodResponse-Ressource für Antworten erstellen, um eine Anforderungsantwort darzustellen, die vom Client empfangen wurde, und Sie erstellen eine IntegrationResponse-Ressource zur Darstellung der Anforderungsantwort, die durch das Backend zurückgegeben wird. 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.

Um Ihren Kunden das Verständnis Ihrer API zu erleichtern, können Sie auch eine Dokumentation für die API, im Rahmen der API-Erstellung oder nachdem die API erstellt wurde, bereitstellen. Hierzu fügen Sie eine DocumentationPart-Ressource für eine unterstützte API-Entität hinzu.

Um zu steuern, wie Clients eine API aufrufen, verwenden Sie IAM-Berechtigungen, einen Lambda-Genehmiger oder einen Amazon Cognito-Benutzerpool. Um die Nutzung Ihrer API zu messen, richten Sie Nutzungspläne ein, um die API-Anforderungen zu drosseln. Diese aktivieren Sie beim Erstellen oder Aktualisieren der API.

Eine Einführung in die Erstellung einer API finden Sie unter Tutorial: Erstellen einer REST-API mit einer Lambda-Proxy-Integration. Weitere Informationen zu den Funktionen von API Gateway, die Sie bei der Entwicklung einer REST-API verwenden können, finden Sie in den nachfolgenden Themen. Diese Themen enthalten konzeptionelle Informationen und Verfahren, die Sie über die API-Gateway-Konsole, die API-Gateway-REST-API, die AWS CLI oder mit einem der AWS-SDKs ausführen können.