# x-amazon-apigateway-api-key-source プロパティ
<a name="api-gateway-swagger-extensions-api-key-source"></a>

 キーを要求する API メソッドを調整する API キーを受け取るソースを指定します。この API レベルのプロパティは、`String` タイプです。API キーを要求するメソッドの設定の詳細については、「[OpenAPI 定義で API キーを使用するようにメソッドを設定する](api-key-usage-plan-oas.md)」を参照してください。

リクエストの API キーのソースを指定します。有効な値は次のとおりです。
+  リクエストの `HEADER` ヘッダーから API キーを受信するための `X-API-Key`。
+ Lambda オーソライザー (以前のカスタムオーソライザー) の `AUTHORIZER` から API キーを受信するための `UsageIdentifierKey` 。



 

## x-amazon-apigateway-api-key-source の例
<a name="api-gateway-swagger-extensions-api-key-source-example"></a>

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

------
#### [ OpenAPI 2.0 ]

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

------
#### [ OpenAPI 3.0.1 ]

```
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Test1"
  },
  "servers" : [ {
    "url" : "/{basePath}",
    "variables" : {
      "basePath" : {
        "default" : "import"
      }
    }
  } ],
  "x-amazon-apigateway-api-key-source" : "HEADER",
   .
   .
   .
}
```

------