RequestModel - AWS Serverless Application Model
語法屬性範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

RequestModel

為特定的 API + 路徑 + 方法配置請求模型。

語法

若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。

YAML

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

屬性

Model

在的「模型」屬性中定義的模型名稱AWS::Serverless::Api。

類型：字串

必要：是

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

Required

在給定 API 端點的 OpenApi 定義的參數部分中添加required屬性。

類型：布林值

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

ValidateBody

指定 API Gateway 是否使用Model來驗證要求主體。如需詳細資訊，請參閱 API Gateway 開發人員指南中的在 API Gateway 中啟用要求驗證。

類型：布林值

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

ValidateParameters

指定 API Gateway 是否使用Model來驗證要求路徑參數、查詢字串和標頭。如需詳細資訊，請參閱 API Gateway 開發人員指南中的在 API Gateway 中啟用要求驗證。

類型：布林值

必要：否

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。

範例

請求型號

請求模型示例

YAML

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