基本的なリクエストの検証を使用したサンプル API の OpenAPI 定義
以下の OpenAPI 定義は、リクエストの検証が有効なサンプル API を定義します。API は、PetStore APIPOST
メソッドを開示し、ペットを pets
コレクションおよび GET
メソッドに追加して、指定されたタイプによりペットのクエリを実行します。
x-amazon-apigateway-request-validators
マップでは、2 つのリクエストの検証が API レベルで宣言されています。params-only
の検証は API で有効になり、GET
メソッドにより継承されます。この検証により、必須のクエリパラメータ (q1
) が受信リクエストに含まれており、空白でないことを API Gateway が確認できるようになります。all
の検証は、POST
メソッドで有効になります。この検証は、必須のヘッダーパラメーター (h1
) が設定されており、空白でないことを検証します。また、ペイロード形式が、指定された RequestBodyModel
形式に準拠していることも検証します。一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。モデルを使用して本文を検証する際、一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。コンテンツタイプに関係なく同じモデルを使用するには、キーとして $default
を指定します。
このモデルでは、入力 JSON オブジェクトに name
、type
、price
の各プロパティが含まれている必要があります。name
プロパティは任意の文字列にすることができ、type
は指定された列挙フィールド (["dog", "cat", "fish"]
) のいずれかでなければなりません。また、price
は 25 から 500 の範囲にする必要があります。id
パラメータは必須ではありません。