Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
RequestModel
Configura un modelo de solicitud para una API+ruta+método específicos.
Sintaxis
Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.
YAML
Model:StringRequired:BooleanValidateBody:BooleanValidateParameters:Boolean
Propiedades
-
Model -
Nombre de un modelo definido en la propiedad Modelos del AWS::Serverless::Api.
Tipo: cadena
Obligatorio: sí
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
Required -
Añade una
requiredpropiedad en la sección de parámetros de la OpenApi definición para el punto final de la API en cuestión.Tipo: Booleano
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.
-
ValidateBody -
Especifica si API Gateway utiliza el
Modelpara validar el cuerpo de la solicitud. Para obtener más información, consulta Habilitar la validación de solicitudes en API Gateway en la Guía para desarrolladores de API Gateway.Tipo: Booleano
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
ValidateParameters -
Especifica si API Gateway utiliza el
Modelpara validar los parámetros de la ruta de solicitud, las cadenas de consulta y los encabezados. Para obtener más información, consulta Habilitar la validación de solicitudes en API Gateway en la Guía para desarrolladores de API Gateway.Tipo: Booleano
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
Ejemplos
Modelo de solicitud
Ejemplo de modelo de solicitud
YAML
RequestModel: Model: User Required: true ValidateBody: true ValidateParameters: true
