x-amazon-apigateway-api-키-소스 속성

API 키를 수신할 소스를 지정하여 키가 필요한 API 메서드를 조절합니다. 이 API 수준 속성은 String 유형입니다.

요청을 위한 API 키의 소스를 지정합니다. 유효한 값은 다음과 같습니다.

• 요청의 HEADER 헤더에서 API 키를 수신하기 위한 X-API-Key.

• Lambda 권한 부여자(이전에는 사용자 지정 권한 부여자라고 함)의 AUTHORIZER로부터 API 키를 수신하기 위한 UsageIdentifierKey.

x-amazon-apigateway-api-키-소스 예제

다음 예는 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",
   .
   .
   .
}