RequestModel - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

RequestModel

Configure un modèle de demande pour une formule Api+Chemin+Méthode spécifique.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

Model

Nom d'un modèle défini dans la propriété Modèles de la AWS::Serverless::Api.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Required

Ajoute une required propriété dans la section des paramètres de la OpenApi définition pour le point de terminaison d'API donné.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

ValidateBody

Indique si API Gateway utilise le Model pour valider le corps de la demande. Pour de plus amples informations, veuillez consulter Activer la validation de demande de base pour une API sur API Gateway dans le Manuel du développeur API Gateway.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

ValidateParameters

Spécifie si API Gateway utilise le Model pour valider les paramètres du chemin de la requête, les chaînes de requête et les en-têtes. Pour de plus amples informations, veuillez consulter Activer la validation de demande de base pour une API sur API Gateway dans le Manuel du développeur API Gateway.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

Modèle de demande

Exemple de modèle de demande

YAML

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