Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Definisi OpenAPI dari API sampel dengan validasi permintaan dasar
Definisi OpenAPI berikut mendefinisikan API sampel dengan validasi permintaan diaktifkan. API adalah bagian dari PetStoreAPIPOST
metode untuk menambahkan hewan peliharaan ke pets
koleksi dan GET
metode untuk menanyakan hewan peliharaan dengan jenis tertentu.
Ada dua validator permintaan yang dideklarasikan dalam x-amazon-apigateway-request-validators
peta di API level. params-only
Validator diaktifkan pada API dan diwarisi oleh metode. GET
Validator ini memungkinkan API Gateway untuk memverifikasi bahwa parameter kueri yang diperlukan (q1
) disertakan dan tidak kosong dalam permintaan masuk. all
Validator diaktifkan pada metode. POST
Validator ini memverifikasi bahwa parameter header yang diperlukan (h1
) disetel dan tidak kosong. Ini juga memverifikasi bahwa format payload mematuhi yang ditentukan RequestBodyModel
Jika tidak ada jenis konten yang cocok ditemukan, validasi permintaan tidak dilakukan. Saat menggunakan model untuk memvalidasi isi, jika tidak ada jenis konten yang cocok ditemukan, validasi permintaan tidak dilakukan. Untuk menggunakan model yang sama terlepas dari jenis konten, tentukan $default
sebagai kunci.
Model ini mensyaratkan bahwa objek input JSON berisiname
,type
, dan price
properti. name
Properti dapat berupa string apa pun, type
harus menjadi salah satu bidang enumerasi yang ditentukan (["dog", "cat", "fish"]
), dan price
harus berkisar antara 25 dan 500. id
Parameter tidak diperlukan.