# x-amazon-apigateway-api-key-source 属性
<a name="api-gateway-swagger-extensions-api-key-source"></a>

 指定源来接收 API 密钥，用于限制获得密钥的 API 方法。此 API 级别属性是 `String` 类型。有关将方法配置为需要 API 密钥的更多信息，请参阅[配置一个将 API 密钥与 OpenAPI 定义结合使用的方法](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",
   .
   .
   .
}
```

------