本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
RequestModel
为特定的 Api + 路径 + 方法配置请求模型。
语法
要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。
YAML
Model:StringRequired:BooleanValidateBody:BooleanValidateParameters:Boolean
属性
-
Model -
在 “模型” 属性中定义的模型的名称AWS::Serverless::Api.
类型:字符串
必需:是
Amazon CloudFormation兼容性:该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
Required -
添加
required属性位于给定 API 终端节点的 OpenAPI 定义的参数部分。类型:Boolean
必需:否
Amazon CloudFormation兼容性:该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
ValidateBody -
指定 API Gateway 是否使用
Model以验证请求正文。有关更多信息,请参阅 。在 API Gateway 中启用请求验证中的API Gateway 开发人员指南.类型:Boolean
必需:否
Amazon CloudFormation兼容性:该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
ValidateParameters -
指定 API Gateway 是否使用
Model以验证请求路径参数、查询字符串和标头。有关更多信息,请参阅 。在 API Gateway 中启用请求验证中的API Gateway 开发人员指南.类型:Boolean
必需:否
Amazon CloudFormation兼容性:该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
示例
请求模型
请求模型示例
YAML
RequestModel: Model: User Required: true ValidateBody: true ValidateParameters: true