REST-API in Amazon API Gateway erstellen - Amazon API Gateway

REST-API in Amazon API Gateway erstellen

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 Resource-Entitäten enthalten kann. Jede Resource-Entität kann wiederum über eine oder mehrere Method-Ressourcen verfügen. In einem Anforderungsparameter und Textkörper ausgedrückt, definiert eine Method die Programmierschnittstelle für den Client, um auf die offengelegte Resource zuzugreifen und stellt eine eingehende Anforderung dar, die vom Client übermittelt wurde. Anschließend erstellen Sie eine Integration-Ressource für die Integration der Method in einen Backend-Endpunkt, der auch als der Integrationsendpunkt bezeichnet wird, indem die eingehende Anfrage an eine bestimmte Integrationsendpunkt-URI weitergeleitet wird. Falls erforderlich, transformieren Sie die Anforderungsparameter oder Textkörper, um die Backend-Anforderungen zu erfüllen. Sie können eine MethodResponse-Ressource für Antworten erstellen, um eine Anfrageantwort darzustellen, die vom Client empfangen wurde, und Sie erstellen eine IntegrationResponse-Ressource zur Darstellung der Anfrageantwort, die vom 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. Um dies zu erreichen, 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. Sie können diese beim Erstellen oder Aktualisieren der API aktivieren.

Sie können diese und andere Aufgaben über die API-Gateway-Konsole, die API-Gateway-REST-API, die AWS CLI oder eines der AWS SDKs ausführen. Nachstehend wird beschrieben, wie Sie diese Aufgaben durchführen.