배포 관리

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

API에는 여러 배포가 있을 수 있습니다. 예를 들어 서로 다른 스테이징 환경 또는 리전이 포함될 수 있습니다. 배포는 사용자가 API를 호출할 수 있는 위치(주소)입니다. 이러한 배포 중 하나는 권장 배포로 표시될 수 있습니다.

배포 탭에는 수정 권한이 있는 사용자가 구성한 API에 대한 모든 배포가 표시됩니다. 배포는 환경에 따라 알파벳 순서로 나열됩니다.

배포 탭, 큰 이미지를 보려면 클릭
API 레지스트리 스키마 보기

다음은 API 허브 API, 버전, 배포, 사양 간의 관계를 보여줍니다.

alt_text
참조 항목 설명
레지스트리 레지스트리는 API 카탈로그 역할을 수행하는 API 모음입니다.
버전 API는 여러 버전을 포함할 수 있습니다. 버전은 클라이언트가 API 호출을 위해 사용할 수 있는 안정적인 인터페이스에 해당합니다. 이러한 버전 중 하나를 권장 버전으로 지정할 수 있습니다. semver의 경우 이러한 버전을 주 버전으로 이해하는 것이 좋습니다.
배포 API에는 여러 스테이징 환경 또는 리전과 같은 여러 배포가 포함될 수 있습니다. 배포는 사용자가 API를 호출할 수 있는 위치(주소)입니다. 이러한 배포 중 하나를 권장 배포로 지정할 수 있습니다.
사양 API 버전을 공식 사양으로 설명하는 것이 좋으며(필수는 아님), 여러 API 사양 형식을 사용하는 경우가 많습니다. 이러한 사양 형식 중 하나가 기본 형식일 수 있으며, 이는 이 버전의 다른 사양에서 파생됨을 나타냅니다.
버전
  • 배포는 업데이트 기록을 갖습니다. 배포 버전은 배포의 특정 인스턴스를 나타내며, 배포가 제공하는 API 구현이 변경된 경우 하나 이상의 사양 버전을 참조할 수 있습니다.
  • 사양에는 업데이트 기록이 포함됩니다. 사양 버전은 사양의 후속 인스턴스를 나타내며 일반적으로 사양 콘텐츠에 대한 브레이킹 체인지가 아닌 다른 변경사항을 나타냅니다. semver의 경우 버전은 부 버전 또는 포인트 버전에 해당할 수 있습니다.

배포 추가

배포를 추가하려면 다음 안내를 따르세요.

  1. Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 배포 탭을 선택합니다.
  4. 배포 추가를 클릭합니다.
  5. 다음을 입력하거나 선택합니다.
    • ID: API 리소스의 식별자입니다. ID는 소문자, 숫자, 하이픈만 포함할 수 있습니다. ID는 프로젝트에서 고유해야 합니다. ID는 4~63자여야 합니다. 배포가 생성된 후에는 ID를 변경할 수 없습니다.
    • 환경: API의 인스턴스를 사용할 수 있는 위치입니다. 예를 들면 프로덕션, 스테이징, 테스트 등입니다.
    • 게이트웨이: 게이트웨이 유형입니다. API를 제공하고 보호하는 데 사용되는 프록시입니다. 시스템 분류로 정의됩니다.

    • API 버전: 이 배포에서 제공하는 API의 버전입니다. 버전에 버전이 없으면 목록에 해당 상태로 표시되고 선택할 수 없습니다.

      버전, 버전 없음
    • 외부 채널 이름 및 URL: 개발자 포털과 같은 API 외부 채널에 대한 링크의 라벨 및 URL입니다.
    • 정보에 액세스
      • 사용 안내: 배포 대상을 지정하는 안내입니다. 예를 들면 공개 소비, 내부 테스트 등입니다.
      • 서버 엔드포인트: API의 서버 엔드포인트입니다.
      • 액세스 안내: API 소비자가 배포에 액세스할 수 있는 방법을 설명하는 자유 형식 마크다운 콘텐츠입니다.
  6. 저장 또는 취소를 클릭합니다.

배포 수정

배포를 수정하려면 다음 안내를 따르세요.

  1. Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 배포 탭을 선택합니다.
  4. 원하는 배포 옆에 있는 더보기 > 수정을 클릭합니다.
  5. 필요에 따라 수정합니다.

  6. 버전 업데이트: 현재 선택한 버전의 사양 버전이 배포에 이미 할당된 것보다 새 버전인 경우 이 확인란이 표시됩니다. 배포된 사양 버전을 업데이트하려면 이 확인란을 선택합니다.

    배포 업데이트 버전 상자
  7. 저장 또는 취소를 클릭합니다.

배포 삭제

배포를 삭제하려면 다음 안내를 따르세요.

  1. Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 배포 탭을 선택합니다.
  4. 원하는 배포 옆에 있는 더보기 > 삭제를 클릭합니다.
  5. 프롬프트에서 삭제(또는 취소)를 클릭합니다.

권장 배포를 설정하거나 삭제하려면 다음 안내를 따르세요.

  1. Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 배포 탭을 선택합니다.
  4. 원하는 배포 행에서 더보기 > 추천 항목으로 설정을 클릭합니다. 권장 배포를 삭제할 수는 없으며, 다른 배포를 권장 배포로 지정할 수만 있습니다.

액세스하기

API에 액세스하는 방법을 확인하려면 다음 안내를 따르세요.

  1. Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 일반 창 또는 배포 탭에서 액세스하기를 클릭하여 액세스 API 패널을 엽니다. 액세스하기 버튼이 없으면 정보가 제공되지 않은 것입니다. 액세스 정보 추가에 대한 안내는 배포 추가를 참조하세요.

  4. 목록에서 배포를 선택합니다. 배포에 액세스 정보가 없으면 목록에 해당 상태로 표시되고 선택할 수 없습니다.

    배포 액세스 정보 없음

외부 채널로 이동

외부 채널로 이동하려면 다음 안내를 따르세요.

  1. Cloud 콘솔에서 API 허브 페이지로 이동합니다.

    API 허브로 이동

    기본적으로 API 목록 페이지가 표시됩니다.

  2. API 목록에서 API 행을 클릭합니다. 개요 탭이 기본적으로 표시됩니다.
  3. 배포 탭을 선택합니다.

  4. 외부 채널 링크를 클릭하여 포털과 같은 외부 채널로 이동합니다(정의된 경우).