RequestModel - AWS Serverless Application Model
SintassiPropertiesEsempi

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

RequestModel

Configura un modello di richiesta per uno specifico metodo Api+Path+.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

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

Properties

Model

Nome di un modello definito nella proprietà Models di. AWS::Serverless::Api

▬Tipo: stringa

Obbligatorio: sì

CloudFormation compatibilità: Questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

Required

Aggiunge una required proprietà nella sezione dei parametri della OpenApi definizione per l'endpoint API specificato.

Tipo: Booleano

Obbligatorio: no

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

ValidateBody

Specifica se API Gateway utilizza Model per convalidare il corpo della richiesta. Per ulteriori informazioni, consulta Abilitare la convalida delle richieste in API Gateway nella Guida per sviluppatori di API Gateway.

Tipo: Booleano

Obbligatorio: no

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

ValidateParameters

Specifica se API Gateway utilizza Model per convalidare i parametri del percorso della richiesta, le stringhe di query e le intestazioni. Per ulteriori informazioni, consulta Abilitare la convalida delle richieste in API Gateway nella Guida per sviluppatori di API Gateway.

Tipo: Booleano

Obbligatorio: no

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

Esempi

Richiedi modello

Esempio di modello di richiesta

YAML

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