Stage 생성하기

API를 배포하기 위해서는 먼저 Stage를 생성해야 합니다.

My Products > APIs > Stage 메뉴로 이동하여 Stage 탭을 선택합니다.

Stage 생성을 클릭합니다.

③ Stage 생성에 필요한 값을 입력합니다.

  • Stage 이름: Stage의 이름을 입력합니다. Stage의 이름은 API Gateway의 호출 URL의 경로에 포함됩니다.
  • Endpoint 도메인: 백엔드 서버의 도메인을 입력합니다. API의 Resource Path와 결합하여 백엔드 서버로 호출할 API 경로가 됩니다.
  • API 캐시: Cache를 설정합니다.
    • TTL: Cache를 유지할 초(sec)를 설정합니다.
  • Throttling: 등록한 Method별로 초당 요청 수를 제한하여 백엔드 서버를 보호합니다.
  • IP ACL: IP를 통해 API 요청을 제어합니다.
  • 유지보수: 모든 API가 정의된 상태코드와 응답을 리턴하도록 설정합니다.

생성을 클릭합니다.

  • Stage가 생성될 때 정의되어 있는 API가 새로운 Stage에 배포됩니다.

API 배포를 클릭합니다.

  • API는 하나의 Stage에는 여러번 배포할 수 있으며 배포 이력을 통해 관리됩니다.

① API 배포에 필요한 값을 입력합니다.

  • 배포할 Stage: 배포할 Stage를 선택합니다.
  • 설명: 배포 설명을 입력합니다.

추가를 클릭합니다.

Stages 탭을 선택합니다.

② 배포한 API를 호출할 수 있는 URL입니다.

이 URL은 다음과 같이 구성됩니다.

https://{product-id}.apigw.ntruss.com/{api-name}/{stage-name}

③ 추가한 Resource가 Stage로 배포됩니다.

API 호출하기

API 배포까지 진행하였다면 API를 호출할 수 있습니다.

API 호출하기를 참고하세요.

내보내기

Stage에 배포된 API는 Swagger Json으로 다운로드할 수 있습니다.

Export 탭을 선택합니다.

② 다운로드할 형식을 선택합니다.

내보내기를 클릭하면 선택한 플랫폼에 맞는 SDK를 다운로드할 수 있습니다.

배포 이력

Stage에는 API를 여러 번 배포할 수 있습니다. 그리고 이전에 배포했던 설정으로 되돌릴 수 있습니다.

Deployment History 탭을 선택합니다.

② Stage에 배포된 Deployment에 표시됩니다.

③ 기존에 배포되어 있던 다른 Deployment를 선택하여 배포할 수 있습니다.

Canary 테스트

수정된 API 명세를 Stage에 배포하기 이전에 Canary 환경을 만들어두고 운영환경에서 테스트할 수 있는 기능을 제공합니다.

Canary 활성화

Canary 활성화 버튼을 클릭하여 현재 정의된 API 명세로 Canary를 활성화 합니다.

Canary 설정

① Canary 설정을 위한 탭을 클릭합니다.

  • Endpoint 도메인
    • Canary의 Endpoint 도메인을 설정합니다.
  • 분배
    • 요청을 Stage와 Canary에 어떻게 분배할지를 결정합니다.
    • 분배 정책
      • Percentage: Canary 요청의 실행 비율을 지정합니다.
      • Condition: 설정한 Header 및 Query String과 요청이 동일하하면 Canary 요청을 실행합니다.
  • API 캐시
    • Stage의 API 캐시를 이용하여 Canary API 캐시를 활성화 합니다.
    • Stage의 API 캐시가 비활성화인 경우 이 기능을 사용할 수 없습니다.
  • Throttling: 등록한 Method별로 초당 요청 수를 제한하여 백엔드 서버를 보호합니다.

② Canary 기반의 Export를 제공합니다.

③ Canary 기반의 Document를 제공합니다.

Canary 승격과 비활성화

Canary 승격 버튼을 클릭하여 Canary를 Stage에 배포합니다. Canary는 비활성화 됩니다.

Canary 비활성화 버튼을 클릭하여 Canary를 삭제합니다.

""에 대한 건이 검색되었습니다.

    ""에 대한 검색 결과가 없습니다.

    처리중...