メニュー
Amazon API Gateway
開発者ガイド

x-amazon-apigateway-api-key-source プロパティ

キーを要求する API メソッドを調整する API キーを受け取るソースを指定します。この API レベルのプロパティは、String タイプです。

リクエストの API キーのソースを指定します。有効な値は次のとおりです。

  • リクエストの X-API-Key ヘッダーから API キーを受信するための HEADER

  • カスタムオーソライザーからの UsageIdentifierKey から API キーを受け取る AUTHORIZER

x-amazon-apigateway-api-key-source の例

次の例では、X-API-Key ヘッダーを API キーソースとして設定します。

{ "swagger" : "2.0", "info" : { "title" : "Test1" }, "schemes" : [ "https" ], "basePath" : "/import", "x-amazon-apigateway-api-key-source" : "HEADER", . . . }

このページの内容: