AWS ドキュメント » Amazon API Gateway » 開発者ガイド » Amazon API Gateway での REST API の作成、デプロイ、および呼び出し » OpenAPI に対する API Gateway 拡張 » x-amazon-apigateway-gateway-responses.gatewayResponse オブジェクト

x-amazon-apigateway-gateway-responses.gatewayResponse オブジェクト

ステータスコード、該当するレスポンスパラメータ、またはレスポンステンプレートを含め、特定のレスポンスタイプのゲートウェイレスポンスを定義します。

プロパティ

プロパティ名	タイプ	説明
responseParameters	x-amazon-apigateway-gateway-responses.responseParameters	GatewayResponse パラメータ (ヘッダーパラメータ) を指定します。パラメータ値は、受信リクエストパラメータ値または静的なカスタム値です。
responseTemplates	x-amazon-apigateway-gateway-responses.responseTemplates	ゲートウェイレスポンスのマッピングテンプレートを指定します。テンプレートは、VTL エンジンでは処理されません。
statusCode	string	ゲートウェイレスポンスの HTTP ステータスコードです。

x-amazon-apigateway-gateway-responses.gatewayResponse の例

次の例の OpenAPI に対する API Gateway 拡張で定義する GatewayResponse では、INVALID_API_KEY レスポンスをカスタマイズして、ステータスコードの 456、受信リクエストの api-key ヘッダー値、および "Bad api-key" メッセージを返します。

    "INVALID_API_KEY": {
      "statusCode": "456",
      "responseParameters": {
        "gatewayresponse.header.api-key": "method.request.header.api-key"
      },
      "responseTemplates": {
        "application/json": "{\"message\": \"Bad api-key\" }"
      }
    }