OpenAPI 확장기능에 대한 작업

개발자 툴킷 CLI extensions 명령을 사용하여 카탈로그 또는 공간에서 OpenAPI 확장을 관리합니다.

사용 중인 IBM® API Connect 버전에 따라 API에 JSON 또는 YAML 확장 스키마를 추가하여 사양을 OpenAPI 확장할 수 있습니다. 확장은 카탈로그로 가져오거나 카탈로그에서 공간으로 가져온 다음 API 스키마에 추가합니다.

여기서 설명하는 명령어는 ‘ OpenAPI ’ 확장 기능을 카탈로그나 스페이스로 가져오고, 이를 확인 및 관리하는 데 사용됩니다. OpenAPI 확장 프로그램을 가져온 후에는 API 정의에서 이를 참조할 수 있습니다. 자세한 내용은 API 정의에서 확장 프로그램 참조하기를 참조하세요.

참고: 카탈로그에서 스페이스(Spaces) 기능이 활성화된 경우, 한 스페이스에 가져온 ‘ OpenAPI ’ 확장 프로그램은 모든 스페이스에 자동으로 적용됩니다. 카탈로그 내의 개별 스페이스에 ‘ OpenAPI ’ 확장 프로그램을 직접 가져올 수는 없습니다. 후속 업데이트도 모든 공간에 적용됩니다.
표 1. 이 표는 확장 명령어에 대한 요약 정보를 제공합니다...

이 표는 명령어와 해당 extensions 기능에 대한 개요를 제공합니다.

명령어 조치 구문
extensions clear extensions:clear 명령은 확장 이름이 제공된 확장의 모든 버전을 삭제합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 지울지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
--confirm <카탈로그_이름>
확장 지우기를 확인합니다.
<확장 이름>
기존 확장의 이름을 지정합니다.
주: 파일 이름이 아닌 확장자 이름입니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
apic extensions:clear --scope catalog|space 
--catalog | -c catalog_name
 extension_name --server | -s management_server_endpoint
--configured-gateway-service gw_service_name 
--confirm catalog_name --org | -o org_name [--space space]
예:
apic extensions:clear --scope catalog 
--catalog catalog1 extension1 --server endpoint1 
--configured-gateway-service gw_service1 
--confirm catalog1 --org my_org

이 예제에서는 my_org 조직의 catalog1에 있고 endpoint1과 쌍을 이루는 extension1 확장의 모든 버전을 삭제합니다.

extensions clear-all extensions:clear-all 명령은 지정된 카탈로그 또는 공간에서 모든 확장을 삭제합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 지울지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
--confirm <카탈로그_이름>
확장 지우기를 확인합니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
apic extensions:clear-all 
--scope catalog|space 
--catalog | -c catalog_name 
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name 
--confirm catalog_name 
--org | -o org_name 
[--space space]
예:
apic extensions:clear-all --scope catalog 
--catalog catalog1 --server endpoint1 
--configured-gateway-service gw_service1 
--confirm catalog1 --org my_org

이 예제에서는 my_org 조직의 catalog1에 있고 endpoint1과 쌍을 이루는 확장을 삭제합니다.

extensions clone extensions:clone 명령은 각 확장에 대한 로컬 정의 파일을 작성합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 복제할지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
org
범위를 조직으로 설정합니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:clone --scope catalog|space 
--catalog | -c catalog_name 
--org | -o org_name 
[--space space] 
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:clone --scope catalog 
--catalog catalog1 --org my_org --server endpoint1 
--configured-gateway-service gw_service_1

이 예제에서는 my_org 조직의 catalog1에 있고 endpoint1과 쌍을 이루는 확장을 복제합니다.

extensions create extensions:create 명령은 확장 정의 파일을 사용하여 카탈로그나 스페이스에 확장을 생성합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 지울지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
<확장 파일>
확장에 대한 새 정보가 포함된 확장 파일의 이름을 지정합니다.
참고: 확장자의 이름이 아닌 OpenAPI 파일 이름입니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:create --scope catalog|space 
extension_file 
--server | -s mgt_server_endpoint 
--catalog | -c catalog_name 
[--space space] 
--org | -o org_name 
--configured-gateway-service gw_service_name
예:
apic extensions:create --scope catalog filename.yaml 
--server endpoint1 --catalog catalog1 --org my_org 
--configured-gateway-service gw_service_1

이 예제는 filename.yamlOpenAPI 확장 정의 파일을 사용하여, 조직 my_org catalog1 내의 확장을 생성하며, 이 확장은 endpoint1 와 페어링됩니다.

extensions delete extensions:delete 명령은 확장의 특정 버전을 삭제합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 지울지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
<extension_name>: <version_number>
확장의 이름 및 버전 번호를 지정합니다.
주: extension_name 은 파일 이름이 아닌 확장자 이름입니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:delete --scope catalog|space 
extension_name:version_number 
--catalog | -c catalog_name 
--org | -o org_name [--space space]
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:delete --scope catalog myextension:1.0.0 
--catalog catalog1 --org orgmain --server endpoint1 
--configured-gateway-service gw_service_1

이 예제에서는 orgmain 조직의 catalog1에 있고 endpoint1과 쌍을 이루는 myextension 버전 1.0.0을 삭제합니다.

extensions get extensions:get 명령은 정의 파일을 불러옵니다.
--scope
카탈로그 또는 공간의 확장을 복제할지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
org
범위를 조직으로 설정합니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
<extension_name>: <version_number>
확장의 이름 및 버전 번호를 지정합니다.
주: extension_name 은 파일 이름이 아닌 확장자 이름입니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:get --scope catalog|space 
extension_name:version_number 
--catalog | -c catalog_name 
--org | -o org_name [--space space] 
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:get --scope catalog myextension:1.0.0 
--catalog catalog1 --org orgmain --server endpoint1 
--configured-gateway-service gw_service_1

이 예제에서는 orgmain 조직의 catalog1에 있고 endpoint1과 쌍을 이루는 myextension 버전 1.0.0을 가져옵니다.

extensions list extensions:list 명령은 확장 이름이 제공된 확장의 모든 버전을 나열합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 복제할지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
org
범위를 조직으로 설정합니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
<확장 이름>
기존 확장의 이름을 지정합니다.
주: 파일 이름이 아닌 확장자 이름입니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:list --scope catalog|space 
extension_name
--catalog | -c catalog_name 
--org | -o org_name 
[--space space]
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:list --scope catalog my_extension 
--catalog catalog1 --org my_org --server endpoint1 
--configured-gateway-service gw_service_1

이 예제에서는 catalog1my_org 조직에 있고 endpoint1과 쌍을 이루는 my_extension 확장의 모든 버전을 나열합니다.

extensions list-all extensions:list-all 명령은 카탈로그 또는 스페이스에서 사용할 수 있는 모든 확장 기능을 나열합니다. 단순히 apic extensions.만 입력하면 이 명령이 기본으로 실행됩니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 복제할지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
org
범위를 조직으로 설정합니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
apic extensions:list-all --scope catalog|space 
--catalog | -c catalog_name 
--org | -o org_name 
[--space space]
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:list-all --scope catalog 
--catalog catalog1 --org my_org --server endpoint1 
--configured-gateway-service gw_service1

이 예제에서는 endpoint1과 쌍을 이루고 catalog1my_org 조직에 있는 확장을 나열합니다.

extensions update extensions:update 명령은 기존 확장 프로그램 버전의 정보를 외부 파일에 있는 정보로 대체합니다.

매개변수는 다음과 같습니다.
--scope
카탈로그 또는 공간의 확장을 지울지 여부를 지정합니다. 다음 선택사항을 사용할 수 있습니다.
catalog
명령이 카탈로그에 적용됩니다.
space
명령이 카탈로그의 공간에 적용됩니다. 카탈로그에서 공간을 사용하는 경우 범위를 space로 설정하고 --space 매개변수를 제공해야 합니다.
--server 또는 -s <management_server_endpoint>
서버 엔드포인트를 지정합니다.
--catalog 또는 -c <catalog_name>
카탈로그 이름과 함께 단일 카탈로그를 지정합니다.
--space
카탈로그에서 공간 이름을 지정합니다. --space 매개변수는 카탈로그에서 공간을 사용하는 경우에 필요합니다. 이 경우에는 명령에 --scope space 도 포함해야 합니다.
--org 또는 -o <organization_name>
조직 이름으로 단일 조직을 지정합니다.
--configured-gateway-service <서비스 이름>
게이트웨이 서비스의 이름을 지정합니다.
<extension_name>: <version_number>
확장의 이름 및 버전 번호를 지정합니다.
주: extension_name 은 파일 이름이 아닌 확장자 이름입니다.
<확장 파일>
확장에 대한 새 정보가 포함된 확장 파일의 이름을 지정합니다.
참고: 확장자의 이름이 아닌 OpenAPI 파일 이름입니다.
apic extensions:update --scope catalog|space 
extension_name:version_number 
extension_file 
--catalog | -c catalog_name 
--org | -o org_name 
[--space space]
--server | -s mgt_server_endpoint 
--configured-gateway-service gw_service_name
예:
apic extensions:update 
--scope catalog extension1:1.0.0 extension2.yaml 
--catalog catalog1 --org my_org --server endpoint1 
--configured-gateway-service gw_service1

이 예제에서는 extension1 버전 1.0.0을 업데이트합니다. 이는 extension2.yaml 파일에서 my_orgcatalog1endpoint1과 쌍을 이룹니다.