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

Proprietà

Model

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

▬Tipo: stringa

Campo obbligatorio: sì

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

Required

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

Tipo: Booleano

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS 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

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS 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

Required: No

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

Esempi

Richiedi modello

Esempio di modello di richiesta

YAML

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