x-amazon-apigateway-request-validators オブジェクト - Amazon API Gateway
x-amazon-apigateway-request-validators の例

x-amazon-apigateway-request-validators オブジェクト

リクエストの検証が含まれる API のサポートされるリクエストの検証を、検証名と関連するリクエスト検証ルールの間のマップとして定義します。この拡張は、REST API に適用されます。

プロパティ名 タイプ 説明

request_validator_name

 x-amazon-apigateway-request-validators.requestValidator オブジェクト

指定された検証で構成される検証ルールを指定します。例: 

    "basic" : {
      "validateRequestBody" : true,
      "validateRequestParameters" : true
    },

特定のメソッドにこの検証を適用するには、basic プロパティの値として検証名 (x-amazon-apigateway-request-validator プロパティ) を参照してください。

x-amazon-apigateway-request-validators の例

次の例は、検証名と関連するリクエスト検証ルールの間のマップとして定義された、API のリクエストの検証のセットを示しています。

OpenAPI 2.0
{
  "swagger": "2.0",
  ...
  "x-amazon-apigateway-request-validators" : {
    "basic" : {
      "validateRequestBody" : true,
      "validateRequestParameters" : true
    },
    "params-only" : {
      "validateRequestBody" : false,
      "validateRequestParameters" : true
    }
  },
  ...
}