Anforderungsvalidierung für REST-APIs in API Gateway
Sie können API Gateway so konfigurieren, dass es eine grundlegende Validierung einer API-Anfrage durchführt, bevor es mit der Integrationsanfrage fortfährt. Wenn die Validierung fehlschlägt, behandelt API Gateway die Anfrage sofort als fehlgeschlagen, gibt eine 400-Fehler-Antwort an den Aufrufer zurück und veröffentlicht die Validierungsergebnisse in CloudWatch Logs. Damit werden unnötige Aufrufe im Backend vermieden. Vor allem aber können Sie die Validierung so speziell auf die Anwendung ausrichten. Sie können einen Anforderungstext validieren, indem Sie überprüfen, ob die erforderlichen Anforderungsparameter gültig sind und nicht den Wert Null haben, oder indem Sie für komplexere Datenvalidierungen ein Modellschema angeben.
Themen
Überblick über die grundlegende Anforderungsvalidierung in API Gateway
API Gateway kann die grundlegende Anforderungsvalidierung durchführen, sodass Sie sich auf die anwendungsspezifische Validierung im Backend konzentrieren können. Für die grundlegende Validierung überprüft API Gateway eine oder beide der folgenden Bedingungen:
-
Die erforderlichen Anforderungsparameter in der URI, der Abfragezeichenfolge und dem Header einer eingehenden Anforderung sind vorhanden und nicht leer. API Gateway überprüft nur das Vorhandensein eines Parameters und nicht den Typ oder das Format.
-
Die entsprechenden Anforderungsnutzdaten entsprechen dem konfigurierten JSON-Schema
der Methodenanforderung für einen bestimmten Inhaltstyp. Wenn kein passender Inhaltstyp gefunden wird, wird die Anforderungsvalidierung nicht durchgeführt. Um dasselbe Modell unabhängig vom Inhaltstyp zu verwenden, legen Sie den Inhaltstyp für Ihr Datenmodell auf $defaultfest.
Zum Aktivieren der grundlegenden Validierung legen Sie Validierungsregeln für eine Anforderungsvalidierung fest, fügen diese dem Schema der Anforderungsvalidierungen für die API hinzu und ordnen anschließend die Validierung den einzelnen API-Methoden zu.
Anmerkung
Das Anfordern einer Textüberprüfung an und Verhalten der Methodenanforderung für Nutzdaten ohne Zuweisungsvorlagen für REST-APIs in API Gateway sind zwei separate Themen. Wenn die Nutzlast einer Anforderung kein passendes Modellschema hat, können Sie Pass-Through wählen oder die ursprüngliche Nutzlast blockieren. Weitere Informationen finden Sie unter Verhalten der Methodenanforderung für Nutzdaten ohne Zuweisungsvorlagen für REST-APIs in API Gateway.
