RequestModel

Konfiguriert ein Anforderungsmodell für eine bestimmte API+Path+Methode.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

YAML

  Model: String
  Required: Boolean
  ValidateBody: Boolean
  ValidateParameters: Boolean

Eigenschaften

Model

Name eines Modells, das in der Models-Eigenschaft von definiert istAWS::Serverless::Api.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Required

Fügt dem Parameterbereich der OpenApi Definition eine required Eigenschaft für den angegebenen API-Endpunkt hinzu.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

ValidateBody

Gibt an, ob API Gateway den verwendetModel, um den Anfragetext zu validieren. Weitere Informationen finden Sie unter Aktivieren der Anforderungsvalidierung in API Gateway im API Gateway Developer Guide.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

ValidateParameters

Gibt an, ob API Gateway die Model zur Überprüfung von Anforderungspfadparametern, Abfragezeichenfolgen und Headern verwendet. Weitere Informationen finden Sie unter Aktivieren der Anforderungsvalidierung in API Gateway im API Gateway Developer Guide.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Beispiele

Anforderungsmodell

Beispiel für ein Anforderungsmodell

YAML

RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true