Entwickeln Sie REST-APIs in API Gateway - Amazon API Gateway

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.

Entwickeln Sie REST-APIs 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. Sie verwenden beispielsweise eine RestApiRessource, um eine API darzustellen, 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-URI weitergeleitet. 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.

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. Um dies zu aktivieren, fügen Sie eine DocumentationPartRessource 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. Sie können diese aktivieren, wenn Sie Ihre API erstellen oder aktualisieren.

Eine Einführung in die Erstellung einer 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 einer REST-API verwenden, finden Sie in den folgenden Themen. Diese Themen enthalten konzeptionelle Informationen und Verfahren, die Sie mit der API Gateway Gateway-Konsole, der API Gateway Gateway-REST-API AWS CLI, dem oder einem der AWS SDKs ausführen können.

Themen