RequestModel

Configura un modello di richiesta per un metodo API+Path+Path+specifico.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la sintassi seguente.

YAML

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

Proprietà

Model

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

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Required

Aggiunge unrequiredproprietà nella sezione parametri della definizione OpenAPI per l'endpoint API specificato.

Type: Booleano

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

ValidateBody

Specifica se API Gateway utilizza ilModelper convalidare il corpo della richiesta. Per ulteriori informazioni, consultaAbilitazione della convalida delle richieste in API GatewaynellaGuida per sviluppatori di API Gateway.

Type: Booleano

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

ValidateParameters

Specifica se API Gateway utilizza ilModelper convalidare i parametri del percorso della richiesta, le stringhe di query e le intestazioni. Per ulteriori informazioni, consultaAbilitazione della convalida delle richieste in API GatewaynellaGuida per sviluppatori di API Gateway.

Type: Booleano

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Esempi

Richiedi modello

Esempio di modello di richiesta

YAML

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