本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 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`，從請求的 `X-API-Key` 標頭接收 API 金鑰。
+ `AUTHORIZER` 適用於從 Lambda 授權方 (先前稱為自訂授權方) 的 `UsageIdentifierKey` 接收 API 金鑰。



 

## 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",
   .
   .
   .
}
```

------