API Gateway에서 REST API에 대한 스테이지 변수 설정

https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

API를 생성한 다음 API의 루트 리소스에 GET 메서드를 생성합니다. 통합 유형을 HTTP로 설정하고 엔드포인트 URL을 http://${stageVariables.url}로 설정합니다.

API를 beta라는 스테이지에 배포합니다.

기본 탐색 창에서 스테이지를 선택한 후 베타 스테이지를 선택합니다.

스테이지 변수 탭에서 편집을 선택합니다.

스테이지 변수 추가를 선택합니다.

이름에 url을 입력합니다. 값에 httpbin.org/get을 입력합니다.

스테이지 변수 추가를 선택하고 다음을 수행합니다.

이름에 stageName을 입력합니다. 값에 beta을 입력합니다.

스테이지 변수 추가를 선택하고 다음을 수행합니다.

이름에 function을 입력합니다. 값에 HelloWorld을 입력합니다.

Save(저장)를 선택합니다.

이제 두 번째 스테이지를 생성합니다. 스테이지 탐색 창에서 스테이지 생성을 선택합니다. 단계 이름에 prod를 입력합니다. 배포에서 최신 배포를 선택한 후 스테이지 생성을 선택합니다.

베타 스테이지와 마찬가지로, 동일한 세 스테이지 변수(url, stageName, function)를 각각 다른 값(petstore-demo-endpoint.execute-api.com/petstore/pets, prod, HelloEveryone)으로 설정합니다.

단계 탐색 창에서 베타를 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 웹 브라우저에 입력합니다. 그러면 API의 루트 리소스에 대한 [beta] 단계 GET 요청이 시작됩니다.

[beta] 단계 GET 요청에서 받은 응답은 다음에 표시됩니다. 브라우저로 [http://httpbin.org/get] 페이지를 탐색해 결과를 확인할 수도 있습니다. 이 값은 [beta] 단계의 url 변수에 할당되었습니다. 이 두 응답은 동일합니다.

단계(Stages) 탐색 창에서 prod 단계를 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 웹 브라우저에 입력합니다. 그러면 API의 루트 리소스에 대한 prod 단계 GET 요청이 시작됩니다.

[prod] 단계 GET 요청에서 받은 응답은 다음에 표시됩니다. 브라우저로 http://petstore-demo-endpoint.execute-api.com/petstore/pets 페이지를 탐색해 결과를 확인할 수 있습니다. 이 값은 [prod] 단계의 url 변수에 할당되었습니다. 이 두 응답은 동일합니다.

리소스 탐색 창에서 GET 메서드를 선택합니다.

쿼리 문자열 파라미터를 메서드의 URL에 추가하려면 메서드 요청 탭을 선택한 다음 메서드 요청 설정 섹션에서 편집을 선택합니다.

URL 쿼리 문자열 파라미터를 선택하고 다음을 수행합니다.

1. 쿼리 문자열 추가(Add query string)를 선택합니다.

2. 이름에 stageName을 입력합니다.

3. 필수 상태로 유지하고 캐싱을 해제합니다.

Save(저장)를 선택합니다.

통합 요청 탭을 선택한 다음 통합 요청 설정 섹션에서 편집을 선택합니다.

엔드포인트 URL의 경우 이전에 정의한 URL 값에 ?stageName=${stageVariables.stageName}을 추가하여 전체 엔드포인트 URL이 http://${stageVariables.url}?stageName=${stageVariables.stageName}이 되도록 합니다.

배포 API를 선택하고 베타 스테이지를 선택합니다.

기본 탐색 창에서 스테이지를 선택합니다. 단계 탐색 창에서 베타를 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 웹 브라우저에 입력합니다.

응답은 다음과 같습니다. beta 단계 변수에 할당된 stageName는 백엔드에 stageName 인수로 전달됩니다.

기본 Node.js 런타임을 사용하여 HelloWorld라는 Lambda 함수를 생성합니다. 코드에는 다음이 포함되어 있습니다.

export const handler = function(event, context, callback) {
    if (event.stageName)
        callback(null, 'Hello, World! I\'m calling from the ' + event.stageName + ' stage.');
    else
        callback(null, 'Hello, World! I\'m not sure where I\'m calling from...');
};

Lambda 함수를 생성하는 방법에 대한 자세한 내용은 REST API 콘솔 시작하기를 참조하세요.

리소스 창에서 리소스 생성을 선택하고 다음을 수행합니다.

1. 리소스 경로에서 /를 선택합니다.

2. 리소스 이름에 lambdav1을 입력합니다.

3. 리소스 생성을 선택합니다.

/lambdav1 리소스를 선택한 다음 메서드 생성을 선택합니다.

뒤이어 다음과 같이 하세요.

1. 메서드 유형에서 GET을 선택합니다.

2. 통합 유형에서 Lambda 함수를 선택합니다.

3. Lambda 프록시 통합을 비활성화된 상태로 유지합니다.

4. Lambda 함수에서 ${stageVariables.function}을(를) 입력합니다.

   

   작은 정보

   권한 명령 추가라는 메시지가 표시되면 add-permission 명령을 복사합니다. function 스테이지 변수에 할당될 각 Lambda 함수에서 명령을 실행합니다. 예를 들어, $stageVariables.function 값이 HelloWorld이면 다음 AWS CLI 명령을 실행합니다.

   aws lambda add-permission --function-name arn:aws:lambda:us-east-1:account-id:function:HelloWorld --source-arn arn:aws:execute-api:us-east-1:account-id:api-id/*/GET/lambdav1 --principal apigateway.amazonaws.com --statement-id statement-id-guid --action lambda:InvokeFunction

   그렇지 않으면 메서드 호출 시 500 Internal Server Error 응답이 반환됩니다. ${stageVariables.function}을 스테이지 변수에 할당된 Lambda 함수 이름으로 바꾸어야 합니다.

   

5. 메서드 생성을 선택합니다.

프로덕션 및 베타 스테이지 모두에 API를 배포합니다.

기본 탐색 창에서 스테이지를 선택합니다. 단계 탐색 창에서 베타를 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 웹 브라우저에 입력합니다. URL에 /lambdav1을 추가한 다음 Enter 키를 누릅니다.

응답은 다음과 같습니다.

"Hello, World! I'm not sure where I'm calling from..."

/lambdav1 리소스를 선택한 다음 메서드 생성을 선택합니다.

뒤이어 다음과 같이 하세요.

1. 메서드 유형에서 POST를 선택합니다.

2. 통합 유형에서 Lambda 함수를 선택합니다.

3. Lambda 프록시 통합을 비활성화된 상태로 유지합니다.

4. Lambda 함수에서 ${stageVariables.function}을(를) 입력합니다.

5. 권한 명령 추가라는 메시지가 표시되면 add-permission 명령을 복사합니다. function 스테이지 변수에 할당될 각 Lambda 함수에서 명령을 실행합니다.

6. 메서드 생성을 선택합니다.

통합 요청 탭을 선택한 다음 통합 요청 설정 섹션에서 편집을 선택합니다.

매핑 템플릿을 선택한 다음 매핑 템플릿 추가를 선택합니다.

콘텐츠 유형에 application/json을 입력합니다.

템플릿 본문에 다음 템플릿을 입력합니다.

#set($inputRoot = $input.path('$'))
{
    "stageName" : "$stageVariables.stageName"
}

Save(저장)를 선택합니다.

베타 및 프로덕션 스테이지 모두에 API를 배포합니다.

REST API 클라이언트를 사용하여 스테이지별 메타데이터를 전달하려면 다음을 수행합니다.

1. 단계 탐색 창에서 베타를 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 REST API 클라이언트의 입력 필드에 입력합니다. /lambdav1을 추가한 후 요청을 제출합니다.

   응답은 다음과 같습니다.

   "Hello, World! I'm calling from the beta stage."

2. 스테이지 탐색 창에서 프로덕션을 선택합니다. 스테이지 세부 정보에서 복사 아이콘을 선택해 API의 호출 URL을 복사하여 REST API 클라이언트의 입력 필드에 입력합니다. /lambdav1을 추가한 후 요청을 제출합니다.

   응답은 다음과 같습니다.

   "Hello, World! I'm calling from the prod stage."

테스트 기능을 사용하여 스테이지별 메타데이터를 전달하려면 다음을 수행합니다.

1. 리소스 탐색 창에서 테스트 탭을 선택합니다. 탭을 표시하려면 오른쪽 화살표 버튼을 선택해야 할 수도 있습니다.

2. function에 HelloWorld를 입력합니다.

3. stageName에 beta를 입력합니다.

4. 테스트를 선택합니다. POST 요청에 본문을 추가할 필요는 없습니다.

   응답은 다음과 같습니다.

   "Hello, World! I'm calling from the beta stage."

5. 이전 단계를 반복하여 프로덕션 스테이지를 테스트할 수 있습니다. stageName에 Prod를 입력합니다.

   응답은 다음과 같습니다.

   "Hello, World! I'm calling from the prod stage."