Trabalhando com extensões do OpenAPI

Use os comandos extensions da CLI do kit de ferramentas do desenvolvedor para gerenciar extensões do OpenAPI nos Catálogos ou nos Espaços.

É possível estender a especificação OpenAPI incluindo um esquema de extensão JSON ou YAML em uma API, dependendo da versão do IBM® API Connect que você está usando Uma extensão é importada em um Catálogo, ou como Space ion a Catalog, depois adicionado ao esquema API.

Os comandos descritos aqui servem para importar OpenAPI extensões para um Catalog ou Space, além de visualizá-las e gerenciá-las. Depois de importar uma extensão OpenAPI poderá fazer referência a ela em suas definições de API; para obter detalhes, consulte Referência a uma extensão em uma definição de API.

Observação: Se os Espaços estiverem ativados em um Catálogo, uma extensão OpenAPI que você importar para um Espaço será importada para todos os Espaços; não é possível importar uma extensão OpenAPI para um Espaço individual no Catálogo. Quaisquer atualizações subsequentes também são aplicadas a todos os Espaços.

Nome do comando	Ação	Sintaxe
extensions clear	O comando extensions:clear exclui todas as versões de uma extensão, dado o nome da extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja limpar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway. --confirm `<nome_do_catálogo>` Confirma a limpeza da extensão. <`extension_name`>. Especifica o nome da extensão existente. Nota: Este é o nome da extensão, não o nome do arquivo. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor.	`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]` Exemplo: `apic extensions:clear --scope catalog --catalog catalog1 extension1 --server endpoint1 --configured-gateway-service gw_service1 --confirm catalog1 --org my_org` Esse exemplo exclui todas as versões da extensão `extension1` que estão em `catalog1` da organização `my_org` e são pareadas com `endpoint1`.
extensions clear-all	O comando extensions:clear-all deleita todas as extensões no Catálogo ou Espaço especificado. Os parâmetros são como a seguir: --scope Especifica se você deseja limpar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway. --confirm `<nome_do_catálogo>` Confirma a limpeza da extensão. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor.	`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]` Exemplo: `apic extensions:clear-all --scope catalog --catalog catalog1 --server endpoint1 --configured-gateway-service gw_service1 --confirm catalog1 --org my_org` Esse exemplo exclui todas as extensões que estão em `catalog1` da organização `my_org` e são pareadas com `endpoint1`.
extensions clone	O comando extensions:clone cria um arquivo de definição local para cada extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja clonar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `org` Configura o escopo para a organização. `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:clone --scope catalog --catalog catalog1 --org my_org --server endpoint1 --configured-gateway-service gw_service_1` Este exemplo clona as extensões que estão em `catalog1` da organização `my_org` e são emparelhadas com `endpoint1`.
extensions create	O comando extensions:create cria uma extensão em um catálogo ou espaço usando um arquivo de definição de extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja limpar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. `<arquivo_de_extensão>` Especifica o nome do arquivo de extensão que contém as novas informações para a extensão. Nota: Este é o nome do arquivo OpenAPI , não o nome do ramal. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:create --scope catalog filename.yaml --server endpoint1 --catalog catalog1 --org my_org --configured-gateway-service gw_service_1` Este exemplo cria uma extensão em `catalog1` da organização `my_org` , que é emparelhada com `endpoint1`, usando o arquivo de definição de extensão `filename.yaml` OpenAPI.
extensions delete	O comando extensions:delete exclui uma versão específica de uma extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja limpar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. <`extension_name`>: <`version_number`> Especifica o nome e o número da versão da extensão. Nota: `extension_name` é o nome da extensão, não o nome do arquivo. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:delete --scope catalog myextension:1.0.0 --catalog catalog1 --org orgmain --server endpoint1 --configured-gateway-service gw_service_1` Esse exemplo exclui `myextension` versão `1.0.0`, que está em `catalog1` da organização `orgmain` e forma um par com `endpoint1`.
extensions get	O comando extensions:get recupera o arquivo de definição para uma versão específica de uma extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja clonar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `org` Configura o escopo para a organização. `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. <`extension_name`>: <`version_number`> Especifica o nome e o número da versão da extensão. Nota: `extension_name` é o nome da extensão, não o nome do arquivo. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:get --scope catalog myextension:1.0.0 --catalog catalog1 --org orgmain --server endpoint1 --configured-gateway-service gw_service_1` Esse exemplo obtém `myextension` versão `1.0.0`, que está em `catalog1` da organização `orgmain` e forma um par com `endpoint1`.
extensions list	O comando extensions:list lista todas as versões de uma extensão, considerando o nome da extensão. Os parâmetros são como a seguir: --scope Especifica se você deseja clonar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `org` Configura o escopo para a organização. `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. <`extension_name`>. Especifica o nome da extensão existente. Nota: Este é o nome da extensão, não o nome do arquivo. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:list --scope catalog my_extension --catalog catalog1 --org my_org --server endpoint1 --configured-gateway-service gw_service_1` Este exemplo lista todas as versões da extensão `my_extension` que são empareladas com `endpoint1`, estão em `catalog1`, e no `my_org` organização.
extensions list-all	O comando extensions:list-all lista todas as extensões disponíveis em um catálogo ou espaço. Esse é o comando padrão se você digitar apenas `apic extensions`. Os parâmetros são como a seguir: --scope Especifica se você deseja clonar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `org` Configura o escopo para a organização. `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway.	`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` Exemplo: `apic extensions:list-all --scope catalog --catalog catalog1 --org my_org --server endpoint1 --configured-gateway-service gw_service1` Este exemplo lista as extensões que são pareadas com o `endpoint1`, estão no `catalog1` e na organização `my_org`.
extensions update	O comando extensions:update substitui as informações de uma versão de extensão existente pelas informações de um arquivo externo. Os parâmetros são como a seguir: --scope Especifica se você deseja limpar as extensões em um Catálogo ou um Espaço. As opções a seguir estão disponíveis: `catalog` O comando deve ser aplicado ao Catálogo `space` O comando deve ser aplicado em um Espaço em um Catálogo. Quando há Espaços ativados em um Catálogo, deve-se configurar o escopo para `space` e fornecer o parâmetro `--space`. --server ou -s <`management_server_endpoint`> Especifica o terminal do servidor. --catalog ou -c <`catalog_name`> Especifica um único Catálogo com o nome do Catálogo. --space Especifica o nome de um Espaço em um Catálogo. O parâmetro `--space` é necessário quando o Catálogo tem Espaços ativados e, nesse caso, também se deve incluir `--scope space` no comando. --org ou -o <`organization_name`> Especifica uma única organização com o nome da organização. --configured-gateway-service `<nome_do_serviço>` Especifica o nome do serviço de gateway. <`extension_name`>: <`version_number`> Especifica o nome e o número da versão da extensão. Nota: `extension_name` é o nome da extensão, não o nome do arquivo. `<arquivo_de_extensão>` Especifica o nome do arquivo de extensão que contém as novas informações para a extensão. Nota: Este é o nome do arquivo OpenAPI , não o nome do ramal.	`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` Exemplo: `apic extensions:update --scope catalog extension1:1.0.0 extension2.yaml --catalog catalog1 --org my_org --server endpoint1 --configured-gateway-service gw_service1` Esse exemplo atualiza a versão `1.0.0` de `extension1` que é pareada com `endpoint1` em `catalog1` e na organização `my_org`, por meio do arquivo `extension2.yaml`.