API 제품 관리

전체 라이프사이클을 통한 products 및 apis 명령 사용

이 예는 런타임 시 제품과 API의 새 버전이 원본 버전을 대체하는 복합적 라이프사이클을 표시합니다.

기본 카탈로그를 설정하고 mgmnthost.comAPI Connect 클라우드에 로그인하세요

apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic login --username some-user --password some-password --server platform-api.myserver.com --realm my-identity-provider

CLI에서 관리 서버에 로그인하는 방법에 대한 전체 세부사항은 관리 서버에 로그인을 참조하십시오.

초기 버전 작성 및 공개

apic create:api --title Routes --version 1.0.0 --filename routes100.yaml
apic create:product --title "Climb On" --version 1.0.0 --apis routes100.yaml --filename climbon100.yaml
apic products:publish climbon100.yaml

API에서 버그를 수정하도록 새 버전을 작성하고 카탈로그에 스테이징

apic create:api --title Routes --version 1.0.1 --filename routes101.yaml
apic create:product --title "Climb On" --version 1.0.1 --apis routes101.yaml --filename climbon101.yaml
apic products:publish --stage climbon101.yaml

카탈로그 조사

apic products:list-all --scope catalog

이 명령어는 카탈로그에 있는 모든 제품을 나열합니다. climbon:1.0.1 제품의 ID를 복사하십시오. ID는 다음 예제와 유사합니다.

https:/server/api/catalogs/3eca6046-3c27-4ad/ab8772bf-0f65-45/products/8f854623-bda1-4f9

맵핑 파일 작성

예를 들어, 특정 제품을 교체할 경우 매핑 파일은 교체할 제품을 지정하고, 원본 제품의 플랜을 대상 제품으로 매핑합니다. 예를 들어, climbon:1.0.0을 climbon:1.0.1로 대체하면 product_url 특성은 climbon:1.0.0의 URL을 지정합니다.

이 파일은 다음과 같은 양식을 사용합니다.

product_url: https:/server/api/catalogs/{id}/products/{id}
plans:
- source: {source_plan_name_1}
  target: {target_plan_name_1}
- source: {source_plan_name_2}
  target: {target_plan_name_2}
            .
            .
            .

참고:

• 소스 및 대상 플랜 이름이 동일하거나 다를 수 있습니다.
• 대체 중인 제품의 모든 플랜은 대체 제품의 플랜에 맵핑되어야 합니다.

버전 1.0.0을 1.0.1로 "즉시 대체"

apic products:replace climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

이러한 방식으로 교체된 후, 지정된 제품은 단종됩니다. 더 이상 활성 상태가 아닙니다.

참고:

명령에 명시된 제품이 교체 제품입니다. 예를 들어, 를 로 climbon:1.0.0 대체하는 climbon:1.0.1 경우, 명령어에 지정된 Product는 입니다 climbon:1.0.1.

버전 1.0.0을 1.0.1로 대체

기존 제품을 새 제품(보통 업데이트된 버전)으로 즉시 대체하지 않고, 기존 제품을 새 제품으로 대체할 수 있습니다. 제품을 대체할 때 해당 제품에 대한 모든 외부 애플리케이션 등록이 새 제품으로 자동으로 이동됩니다. 제품을 대체할 때, 등록은 새 제품으로 자동으로 이동되지 않으며 외부 애플리케이션이 대체 제품으로 등록하도록 일부 조치를 수행해야 합니다.

제품을 대체하는 명령은 제품을 대체할 명령과 동일한 맵핑 파일을 사용합니다. 명령어에 대체할 제품의 이름이 명시되어 있습니다.

apic products:supersede climbon:1.0.1 PRODUCT_PLAN_MAPPING_FILE

제품이 대체되면 해당 제품은 ‘사용 중단 예정’으로 표시됩니다. 이는 해당 제품에 대한 신규 구독이 더 이상 허용되지 않음을 의미하지만, 제품은 여전히 활성화되어 있으며 기존 구독은 계속 유효합니다.

참고: 명령어에 명시된 제품은 이전 버전을 대체하는 제품입니다. 예를 들어, 를 로 climbon:1.0.0 대체하는 climbon:1.0.1 경우, 명령어에 지정된 Product는 입니다 climbon:1.0.1. 매핑 파일에는 대체할 제품의 제품 식별자( URL )가 명시되어 있습니다.

마이그레이션 대상 설정

기존 제품을 위한 마이그레이션 목표를 설정할 수 있습니다. 이는 마이그레이션에 도움이 됩니다.

마이그레이션 대상을 설정하려면 다음과 같은 명령을 사용하십시오.

apic products:set-migration-target climbon:1.0.0 PRODUCT_PLAN_MAPPING_FILE

참고: 명령어에 지정된 제품은 구독을 마이그레이션하려는 제품입니다. 맵핑 파일은 등록을 위한 대상 제품을 지정합니다.

마이그레이션 대상이 설정되면, 외부 애플리케이션 개발자는 Consumer Catalog 를 통해 애플리케이션 구독을 손쉽게 마이그레이션할 수 있습니다. 다음 명령어를 사용하여 구독 마이그레이션을 실행할 수도 있습니다.

apic products:execute-migration-target climbon:1.0.0

제품 삭제

교체되거나 대체된 제품이 더 이상 필요하지 않은 경우 삭제될 수 있습니다.

apic products:delete climbon:1.0.0