RequestModel - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

RequestModel

Configura um modelo de solicitação para uma API+Path+Method específica.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

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

Propriedades

Model

Nome de um modelo definido na propriedade Models doAWS::Serverless::Api.

Type: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Required

Adiciona uma required propriedade na seção de parâmetros da OpenApi definição para o determinado endpoint da API.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

ValidateBody

Especifica se o API Gateway usa o Model para validar o corpo da solicitação. Para obter mais informações, consulte Ativar validação de solicitação no API Gateway no Guia do desenvolvedor do API Gateway.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

ValidateParameters

Especifica se o API Gateway usa o Model para validar parâmetros do caminho da solicitação, cadeias de caracteres de consulta e cabeçalhos. Para obter mais informações, consulte Ativar validação de solicitação no API Gateway no Guia do desenvolvedor do API Gateway.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Exemplos

Modelo de solicitação

Exemplo de modelo de solicitação

YAML

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