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

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

RequestModel

設定特定 Api+Path+Method 的請求模型。

語法

若要在 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