RequestModel - AWS Serverless Application Model
SintaksPropertiContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

RequestModel

Mengkonfigurasi Model Permintaan untuk Metode Api+Path+tertentu.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

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

Properti

Model

Nama model yang ditentukan dalam properti Model dari AWS::Serverless::Api.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Required

Menambahkan required properti di bagian parameter OpenApi definisi untuk titik akhir API yang diberikan.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

ValidateBody

Menentukan apakah API Gateway menggunakan Model untuk memvalidasi badan permintaan. Untuk informasi selengkapnya, lihat Mengaktifkan validasi permintaan di API Gateway di Panduan Pengembang API Gateway.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

ValidateParameters

Menentukan apakah API Gateway menggunakan Model untuk memvalidasi parameter jalur permintaan, string kueri, dan header. Untuk informasi selengkapnya, lihat Mengaktifkan validasi permintaan di API Gateway di Panduan Pengembang API Gateway.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

Model Permintaan

Contoh Permintaan Model

YAML

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