Visão geral da ferramenta de linha de comandos

Editar online

O IBM® API Connect developer toolkit fornece comandos para administração de nuvem e desenvolvimento e gerenciamento de API.

Sintaxe de Comando

Em geral, os comandos têm a seguinte sintaxe:
apic command:sub-command [argument] [options]
em que
  • command é o comando, geralmente aquilo no qual você está agindo (por exemplo, produto, app, API, catálogos e assim por diante).
  • sub-command é a ação a ser executada.
  • argument é o argumento, onde aplicável (por exemplo, catalog).
  • options é qualquer número de opções de linha de comandos, que têm o formato --option [value]. As opções também têm um formato curto com um traço único em vez de um traço duplo.
Por exemplo, apic apps:publish --server mgmnthost.com.
Para alguns comandos, a parte do comando ou subcomando é opcional. Por exemplo:
  • apic products:publish é equivalente a apic publish.
  • apic products:list é equivalente a apic products.
O comando create possui uma sintaxe um pouco diferente:
apic create:type [options]
Use a opção -h ou --help para visualizar a ajuda do comando.
Nota: o idioma no qual o texto de ajuda da CLI e outro texto de resposta de comando são exibidos é determinado pela configuração do código de idioma em sua máquina local...

Visualizando a ajuda da ferramenta de linha de comandos

Exiba informações gerais da ajuda da linha de comandos inserindo o comando a seguir: apic --help or apic -h. Exiba informações da ajuda para um comando apic específico inserindo o comando a seguir: apic command_name --help ou apic command_name -h.

Visualizando informações da versão

Exibir a versão da ferramenta de linha de comandos inserindo o comando: apic --version.

Usando variáveis de configuração

É possível definir os valores de propriedades comumente usadas em variáveis de configuração. Em geral, é mais fácil e mais consistente configurar variáveis de configuração em vez de especificá-las usando as opções da linha de comandos.
Nota:

As variáveis de configuração dos projetos do ` OpenAPI ` são sempre globais. Os valores de variáveis de configuração globais são armazenados no arquivo user-home-dir/.apiconnect/config, em que user-home-dir é o diretório inicial do usuário.

Use os comandos a seguir para trabalhar com variáveis de configuração:

  • apic config:get varname - Obter uma variável de configuração. Use apic config para exibir os valores de todas as variáveis de configuração locais ou apic config -g para exibir os valores de todas as variáveis de configuração globais.
  • apic config:set varname - Configurar ou atualizar a variável de configuração especificada.
  • apic config:delete varname - Excluir a variável de configuração especificada.
  • apic config:clear - Excluir todas as variáveis de configuração.

Você configura os valores da propriedade de configuração usando o comando apic config:set Ao configurar propriedades de configuração (por exemplo, catalog e app), não é necessário fornecer valores para essas opções ao inserir um comando.

Além disso, é possível usar os comandos de apic properties para trabalhar com propriedades de configuração:
  • apic properties:clear - limpa as propriedades de configuração.
  • apic properties:create - aumenta as propriedades de configuração com pares nome/valor adicionais.
  • apic properties:delete - exclui a propriedade de configuração.
  • apic properties:get - obtém a propriedade de configuração.
  • apic properties:list - lista as propriedades de configuração.
  • apic properties:update - atualiza a propriedade de configuração.
Nota:

Se você tiver uma variável de ambiente com o mesmo nome de uma propriedade de configuração da CLI, por padrão, o valor dela substituirá o valor da propriedade de configuração da CLI correspondente de qualquer comando da CLI nesse escopo.

Por exemplo, se você tiver definido uma variável de ambiente chamada SPACE, por padrão, esse valor será assumido para o valor do parâmetro --space no comando a seguir, independentemente de qualquer configuração de propriedade de configuração space:
apic products:publish my_product.yaml --scope space

Para evitar que as variáveis de ambiente substituam as propriedades de configuração da CLI, defina uma variável de ambiente chamada APIC_LOAD_FROM_ENV, configurada como o valor false.

A tabela a seguir descreve as variáveis de configuração:

Tabela 1. Variáveis de configuração
Nome da variável Descrição Use no lugar (ou em substituição) dessas sinalizações...
catálogo Nome padrão do catálogo para todos os comandos que gerenciam aspectos de um catálogo.
O valor do Catálogo pode ser especificado como:
  • O URI completo do catálogo, que inclui o nome do servidor e o nome da organização: mgmt-server/api/catalogs/org-name/catalog-name. Nesse caso, não é necessário especificar --catalog, --organization, ou --server ao realizar chamadas via CLI, uma vez que seus valores já estão incluídos no URI completo do Catálogo.
  • O nome do catálogo, por exemplo: sandbox. Nesse caso, você ainda precisa especificar --organization e --server ao fazer chamadas pela CLI.
Nota: o nome do Catálogo apic-dev é reservado para teste local.
  • Se o URI do catálogo for usado na atribuição de variáveis: --catalog, --organization, --server
  • Se o nome do catálogo for usado na atribuição de variáveis: --catalog
nuvem Nome do host do servidor de gerenciamento padrão para comandos de administração de nuvem. Formato: mgmt-server/api/. --server
consumidor URI padrão de um consumidor da API. Formato: mgmt-server/api/consumer-orgs/org-name/catalog-name/consumer-org-name, em que mgmt-server é o servidor de gerenciamento, org-name é o nome da organização, catalog-name é o nome do catálogo e consumer-org-name é o nome da organização do consumidor. -–server, -–organization, -–catalog, -–consumer
modo O valor padrão do parâmetro --mode para comandos da CLI. Configure o valor como apim ou consumer caso queira executar comandos em uma organização do provedor ou em uma organização do consumidor. Se você não configurar essa variável e não fornecer um parâmetro --mode em um comando, o valor apim será assumido. --mode
org Nome padrão da organização para todos os comandos que gerenciam organizações.

Formato: mgmt-server/api/orgs/org-name, em que mgmt-server é o servidor de gerenciamento, org-name é o nome da organização.

O valor org pode ser especificado como:
  • O URI completo da organização, que inclui o nome do servidor: mgmt-server/api/orgs/org-name. Nesse caso, você não precisa especificar --server ou --organization ao fazer chamadas pela CLI, já que seus valores estão incluídos no URI completo da organização.
  • O nome da organização, por exemplo: providerorg1. Nesse caso, você ainda precisa especificar --server quando fizer chamadas via CLI.
  • Se o URI da organização for usado na atribuição de variáveis: --organization, --server
  • Se o nome da organização for usado na atribuição de variáveis: --organization
Espaço URI de Espaço padrão para todos os comandos que gerenciam aspectos de um Espaço

Formulário: mgmt-server/api/spaces/org-name/catalog-name/space-name, em que mgmt-server é o servidor de gerenciamento, org-name é o nome da organização, catalog-name é o nome do catálogo e space-name é o nome do Espaço .

É possível anexar o número da porta ao nome do servidor caso não seja o valor padrão 443.

 --server, --organization, --catalog, --space
Para configurar propriedades de configuração, insira o seguinte comando:
apic config:set name=value
em que name é o nome da propriedade de configuração e value é o valor a ser designado a ela.

Por exemplo:

apic config:set catalog=sandbox

Comandos de Script

É sempre útil automatizar uma série de comandos apic em um script de shell. Como primeiro a ferramenta apic requer que você aceite a licença interativamente, você deve usar o seguinte comando:
apic --accept-license
Depois de fazer isso, seus scripts podem ser executados não interativamente.
Para desativar a coleta de análises de uso, insira este comando:
apic --live-help

Configuração do idioma

Você pode configurar o idioma das saídas de comando da CLI usando o sinalizador ' --lang. Esse sinalizador permite que o kit de ferramentas do desenvolvedor forneça saídas de comando no idioma especificado. A tabela a seguir contém os idiomas suportados:

Tabela 2. Idiomas suportados
Valor do idioma Idioma
pt-br Inglês (EUA)
cs Tcheco
de Alemão
Es Espanhol
fr Francês
ele Italiano
Ja Japonês
ko Coreano
nl Holandês
pl Polonês
pt-br Português (Brasil)
ru Russo
tr Turco
zh-cn Chinês (simplificado)
zh-tw Chinês (tradicional)
Use os valores de um idioma com base em suas necessidades. Use o francês como exemplo. Para definir o idioma como francês, execute o seguinte comando:
apic --lang fr
Depois de executar o comando, os resultados são exibidos em francês. Por exemplo:
apic config get invalid
Error: invalid n'est pas une variable de configuration valide
Quando você fornece um valor inválido que não é um idioma suportado, o sistema exibe o seguinte erro:
apic --lang invalid
Error: Value invalid is not valid for lang. Valid values are: en-us, cs, de, es, fr, it, ja, ko, nl, pl, pt-br, ru, tr, zh-cn, zh-tw