Amazon API Gateway
개발자 안내서

API Gateway 콘솔에서 REST API 배포

REST API를 처음 배포하기 이전에 생성해야 합니다. 자세한 내용은 Amazon API Gateway에서 REST API 생성 단원을 참조하십시오.

REST API를 단계에 배포

API Gateway 콘솔을 통해 배포를 생성한 다음 새 단계 또는 기존 단계에 연결하여 API를 배포할 수 있습니다.

참고

API Gateway의 단계를 다른 배포에 연결하려면 대신 다른 REST API 배포에 단계 연결 단원을 참조하십시오.

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

  2. 배포하고자 하는 API를 API(APIs) 탐색 창에서 선택합니다.

  3. 리소스 탐색 창에서 작업을 선택합니다.

  4. 작업 드롭다운 메뉴에서 API 배포를 선택합니다.

  5. API 배포 대화 상자에서 배포 단계 드롭다운 목록에 있는 입력을 선택합니다.

  6. [새 단계]([New Stage])를 선택한 경우 단계 이름(Stage name)에 이름을 입력하고 필요에 따라 단계 설명(Stage description)배포 설명(Deployment description)에 단계 및 배포에 대한 설명을 제공합니다. 기존 단계를 선택한 경우 배포 설명(Deployment description)에 새 배포에 대한 설명을 제공해야 할 수 있습니다.

  7. 배포를 선택하여 API를 기본 단계 설정과 함께 지정된 단계에 배포합니다.

REST API를 단계에 재배포

API를 재배포하려면 REST API를 단계에 배포의 단계와 같은 단계를 수행합니다. 원하는 만큼 같은 단계를 재사용할 수 있습니다.

REST API 배포의 단계 구성 업데이트

API를 배포한 후 단계 설정을 수정하여 API 캐시, 로깅 또는 요청 조절을 활성화 또는 비활성화할 수 있습니다. 또한 백엔드에서 API Gateway를 인증하는 데 사용할 클라이언트 인증서를 선택하고 런타임에 배포 컨텍스트를 API 통합에 전달하도록 단계 변수를 설정할 수 있습니다. 자세한 내용은 단계 설정 업데이트 단원을 참조하십시오.

중요

단계 설정을 수정한 후에는 API를 다시 배포해야 변경 사항이 적용됩니다.

참고

업데이트된 설정(예: 로깅 활성화)에 새 IAM 역할이 필요한 경우 API를 다시 배포하지 않고 필요한 IAM 역할을 추가할 수 있습니다. 그러나 새 IAM 역할을 적용하는 데 몇 분 정도 걸릴 수 있습니다. 그 이전에는 로깅 옵션을 활성화한 경우에도 API 호출에 대한 추적 사항이 기록되지 않습니다.

REST API 배포에 대한 단계 변수 설정

배포에 대해 런타임에 배포 관련 데이터를 API 통합에 전달하도록 단계 변수를 설정하거나 수정할 수 있습니다. 이 작업은 단계 편집기(Stage Editor)단계 변수(Stage Variables) 탭에서 수행할 수 있습니다. 자세한 내용은 REST API 배포에 대한 단계 변수 설정 단원의 지침을 참조하십시오.

다른 REST API 배포에 단계 연결

배포는 API 스냅샷을 나타내고 단계는 스냅샷에 대한 경로를 정의하므로 다른 배포-단계 조합을 선택하여 사용자가 API의 다른 버전을 호출하는 방법을 제어할 수 있습니다. 이 기능은 API 상태를 이전 배포로 롤백하거나 API의 '프라이빗 분기'를 퍼블릭 분기로 병합하려는 경우 등에 유용합니다.

다음 절차에서는 API Gateway 콘솔에서 단계 편집기(Stage Editor)를 사용하여 이 작업을 수행하는 방법을 보여줍니다. 여기서는 API를 두 번 이상 배포했다고 가정합니다.

  1. 단계 편집기(Stage Editor)에서 아직 하지 않은 경우, API(APIs) 기본 탐색 창의 단계(Stages) 옵션에서 배포를 업데이트하고자 하는 단계를 선택합니다.

  2. 배포 기록(Deployment History) 탭에서 단계를 사용하고자 하는 배포 옆에 있는 옵션 버튼을 선택합니다.

  3. 배포 변경(Change Deployment)을 선택합니다.