Comandos de desenvolvimento e de gerenciamento de API

Um resumo dos comandos principais no kit de ferramentas do desenvolvedor do IBM® API Connect

Autenticando

Use o comando apic login para autenticar em um serviço do API Manager e o comando apic logout para remover suas credenciais de autenticação local.

Nota: quando você se autentica com sucesso, suas credenciais são armazenadas, em texto simples, no arquivo [Icon indicating that this applies on Linux platforms]

.netrc ou

_netrc. Portanto, é necessário configurar as permissões de arquivo de tal forma que suas credenciais não sejam acessíveis por outros.

Para obter detalhes completos sobre como efetuar login em seu servidor de gerenciamento por meio da CLI, consulte "Efetuando login no kit de ferramentas" em Configurando o kit de ferramentas do API Connect

Configurando a ferramenta de linha de comandos para usar certificados TLS

API Manager usa perfis TLS para proteger a transmissão de dados. Para obter informações sobre como criar um perfil TLS no API Manager, consulte Perfis TLS.

Para configurar a ferramenta de linha de comandos do kit de ferramentas para usar certificados para se comunicar com um API Manager que tenha perfis TLS ativados, siga estas etapas:

Para obter mais informações sobre a variável de ambiente NODE_EXTRA_CA_CERTS, consulte Documentação do Node.js :..

Criando e gerenciando arquivos locais

Você cria e trabalha com arquivos YAML de API e de definição de Produto localmente antes de prepará-los para o API Manager.

Para criar um arquivo de definição da API local, use o comando apic create:api. Para criar um arquivo de definição local do Produto, use o comando apic create:product.

Use os comandos apic apis e apic products para listar artefatos do API Manager do tipo especificado.

Para validar a exatidão sintática de um arquivo de definição local da API ou do produto, use o comando apic validate.

Para criar uma API de rascunho no API Manager a partir de um arquivo de definição de API ou Produto local, use os comandos apic draft-apis:create e apic draft-products:create , respectivamente.

Nota: Se o arquivo OpenAPI que define a sua API usar um campo $ref para referenciar um fragmento do código OpenAPI que é definido em um arquivo separado, o campo $ref será substituído pelo conteúdo do arquivo de destino antes que uma API seja validada, criada em rascunho, montada ou publicada. Para obter mais informações, consulte Usando $ref para reutilizar fragmentos de código em seus arquivos OpenAPI..

Pesquisa de caminhos de API com suporte a curinga

Você pode realizar pesquisas flexíveis no caminho completo das APIs publicadas em um catálogo usando o novo parâmetro de consulta full_path nos comandos apis:list e apis:list-all . O parâmetro full_path permite que você pesquise usando o caminho completo da API, que inclui o caminho base e o caminho. Esse aprimoramento na pesquisa de caminho de API permite pesquisas mais avançadas e flexíveis quando você está gerenciando grandes conjuntos de APIs. Use esse recurso para localizar rapidamente as APIs com base em seus caminhos completos publicados, aumentando a eficiência em ambientes grandes.

Há suporte para os seguintes curingas:

*: corresponde a zero ou mais caracteres.
?: corresponde a qualquer caractere único.

Por exemplo,

Você pode usar o seguinte comando para pesquisar APIs com o caminho exato /test:

apic apis:list-all -s <server> --scope catalog -o <org> -c <catalog> --full_path=/test

Você pode usar o seguinte comando para pesquisar APIs em que o caminho completo começa com /test:

apic apis:list-all -s <server> --scope catalog -o <org> -c <catalog> --full_path=/test*

Trabalhando com Catálogos e Espaços

Para criar um catálogo, use o comando apic catalog:create. Para visualizar informações sobre um Catálogo, use o comando apic catalog:get; para listar todos os Catálogos contidos em organizações das quais o usuário autenticado atualmente é um membro, use o comando apic catalogs.

É possível usar um Espaço para particionar um catálogo para que várias equipes possam gerenciar os produtos e APIs independentemente em um único catálogo. Um espaço é conceitualmente como um subcatálogo, exceto pelo fato de que os produtos e as APIs em todos os espaços de um catálogo são publicados no mesmo portal CMS. Para obter mais informações sobre o Spaces, consulte Usando a distribuição em IBM API Connect.

Para ativar Espaços para um Catálogo, use o comando a seguir:

apic catalogs:set catalog_name --spaces enabled

Use os comandos apic spaces do kit de ferramentas para criar e gerenciar Espaços:

apic spaces -listar Espaços contidos em um Catálogo
apic:spaces create -Criar um Espaço em um catálogo.
apic:spaces get -Obter informações sobre um Espaço em um Catálogo
apic:spaces set -Configurar informações em um Espaço em um catálogo.
apic:spaces delete -Exclua um Espaço em um Catálogo

Sumarização do comando

As tabelas a seguir resumem os comandos apic para desenvolvimento e gerenciamento de API.

Tabela 1. Resumo de comandos de propósito geral
Comando	Descrição	Subcomandos
`apic config`	Listar e gerenciar variáveis de configuração. Para obter mais informações, consulte Usando variáveis de configuração. Sem nenhum subcomando, lista valores de variáveis de configuração definidas.	`apic config` - gerencia variáveis de configuração `apic config:clear` - exclui todas as variáveis de configuração `apic config:delete` - exclui uma variável de configuração `apic config:get` - obtém uma variável de configuração `apic config:list` - lista as variáveis do aplicativo e de configuração global `apic config:set` - configura ou atualiza as variáveis de configuração
`apic create`	Crie uma API de rascunho ou um arquivo YAML de definição do Produto.	`create:api` - Criar um arquivo YAML de definição de API OpenAPI `create:product` - Criar um arquivo YAML de definição de Produto
`apic extensions`	Gerencie extensões do OpenAPI em um catálogo. Sem nenhum subcomando, lista as extensões no Catálogo de produção.	`apic extensions` - operações de coleta de Extensão. `apic extensions:clear` - Excluir todas as versões de uma extensão, dado o nome. `apic extensions:clear-all` - Excluir todas as versões de todas as extensões. `apic extensions:clone` - Fazer download de todas as versões de todas as extensões em sua unidade local. `apic extensions:create` - Criar uma extensão. `apic extensions:delete` - Excluir uma extensão por ID ou por nome e versão. `apic extensions:document` - Obter o documento para uma extensão por ID ou por nome e versão. `apic extensions:get` - Obter uma extensão por ID ou por nome e versão. `apic extensions:list` - listar todas as versões de uma extensão dada ao nome. `apic extensions:list-all` - listar todas as versões de todas as extensões. `apic extensions:update` -Atualize uma extensão por ID, ou por nome e versão.
`apic login`	Efetuar login no API Manager.	Nenhum. Especifique o servidor e credenciais com os sinalizadores necessários: `-p, --password` `senha` `-r, --realm` `região`.. Determina o provedor de identidade que é usado para autenticar o ID do usuário fornecido e o escopo das tarefas que podem ser executadas após o login bem-sucedido. `-s, --server` `mgmt_endpoint_url`.. Use o valor da URL de terminal da API da plataforma para essa entrada. `-u, --username` `nome_do_usuário` Para obter detalhes completos sobre como efetuar login em seu servidor de gerenciamento por meio da CLI, consulte "Efetuando login no kit de ferramentas" em Configurando o kit de ferramentas do API Connect
`apic logout`	Efetuar logout do API Manager.	Nenhum. Especifique o servidor com o sinalizador necessário: `-s, --server` `mgmt_service`.. É possível anexar o número da porta ao nome do servidor caso não seja o valor padrão 443.
`apic validate`	Validar arquivo YAML de definição de API ou de produto.	Nenhum

Tabela 2. Resumo de comandos para gerenciar APIs, Produtos e Catálogos
Comando	Descrição	Subcomandos
`apic apis`	Listar e gerenciar APIs que são montadas ou publicadas no Catálogo ou Espaço. O subcomando padrão é `list-all`.	`apic apis` - operações de coleta de API `apic apis:get` - Obter o arquivo YAML de definição do OpenAPI para uma API por nome e versão ou por ID `apic apis:list` -Lista uma API por nome `apic apis:list-all` - Listar todas as APIs em um Catálogo ou um Espaço `apic apis:update` - Atualizar uma API por nome
`apic apps`	Listar e gerenciar aplicativos do desenvolvedor registrados em uma organização do consumidor. O subcomando padrão é `list`.	`apic apps` - Operações de coleta de aplicativos `apic apps:clear` - Limpar todos os aplicativos `apic apps:create` - Criar um aplicativo `apic apps:delete` - Excluir um aplicativo por nome ou ID `apic apps:get` - Obter um objeto de aplicativo por nome `apic apps:list` - Listar todos os aplicativos em uma organização do consumidor `apic apps:update` -Atualize um aplicativo por nome ou ID
`apic catalogs`	Listar e gerenciar Catálogos em uma organização do provedor. O subcomando padrão é `list`.	`apic catalogs:clear` - Limpar todos os Catálogos da organização do provedor `apic catalogs:create` - cria um Catálogo `apic catalogs:delete` - Excluir um Catálogo por nome ou ID `apic catalogs:get` - Obter um objeto de Catálogo por nome ou ID `apic catalogs:list` - Listar todos os Catálogos em uma organização do provedor `apic catalogs:transfer-owner` - Transferir a propriedade de um Catálogo para outro usuário `apic catalogs:update` - Atualizar um Catálogo por nome ou ID
`apic catalog-settings`	Gerenciar as definições de configuração de um Catálogo	`apic catalog-settings:get` - Obter as configurações do Catálogo. `apic catalog-settings:update` -Atualize as configurações do Catálogo.
`apic drafts`	Listar e gerenciar as definições da API e do Produto de rascunho em uma organização do provedor. O subcomando padrão é `list`.	`apic drafts` - cria um rascunho das operações de coleta `apic drafts:clear` - Excluir todas as APIs e os Produtos de rascunho em uma organização do provedor `apic drafts:list` - Listar as APIs e os Produtos de rascunho em uma organização do provedor
`apic draft-apis`	Listar e gerenciar as definições da API de rascunho em uma organização do provedor. O subcomando padrão é `list-all`.	`apic draft-apis` - operações de coleta de API de Rascunho `apic draft-apis:clear` - Excluir todas as versões de uma API de rascunho pelo nome `apic draft-apis:clear-all` - Excluir todas as APIs de rascunho em uma organização do provedor `apic draft-apis:clone` -Clonar todas as APIs de rascunho em uma organização do provedor `apic draft-apis:create` - Criar uma API de rascunho `apic draft-apis:delete` - Excluir uma API de rascunho por nome e versão `apic draft-apis:document` -obter o documento da API de rascunho por nome e versão `apic draft-apis:get` - Obter o arquivo YAML de definição do OpenAPI para uma API por nome e versão `apic draft-apis:list` - Listar todas as versões de uma API de rascunho por nome `apic draft-apis:list-all` -Lista todos os APIs de rascunho em uma organização do provedor `apic draft-apis:update` - Atualizar uma API de rascunho por nome e versão, fornecendo o arquivo de definição revisado do OpenAPI `apic draft-apis:update-wsdl` -Atualizar uma API SOAP de rascunho por nome e versão, fornecendo o arquivo de definição WSDL revisado em um formato .wsdl ou .zip Nota: Deve haver uma correspondência dos nomes de serviços no WSDL existente com o WSDL revisado. Se uma correspondência for localizada, o serviço WSDL será convertido em um arquivo YAML usado para atualizar a API. Se nenhuma correspondência for localizada, uma mensagem de erro será exibida.. `apic draft-apis:validate` - Valida uma API de rascunho `apic draft-apis:wsdl` -Obter o documento WSDL da API de Rascunho por nome e versão..
`apic draft-products`	Listar e gerenciar as definições do Produto de rascunho em uma organização do provedor. O subcomando padrão é `list-all`.	`apic draft-products` - operações de coleta de Produto de Rascunho `apic draft-products:clear` - Excluir todas as versões de um Produto de rascunho por nome `apic draft-products:clear-all` - Excluir todos os Produtos de rascunho em uma organização do provedor `apic draft-products:create` - Criar um Produto de rascunho `apic draft-products:delete` - Excluir um Produto de rascunho por nome e versão `apic draft-products:get` - obtém o Produto de Rascunho por nome e versão `apic draft-products:list` - lista os Produtos de Rascunho `apic draft-products:list-all` - Listar todos os Produtos de rascunho em uma organização do provedor `apic draft-products:publish-all` - publica o Produto de Rascunho `apic draft-products:update` - Atualizar um Produto de rascunho por nome e versão, fornecendo o arquivo de definição revisado `apic draft-products:validate` - Validar um Produto de rascunho
`apic members`	Listar e gerenciar os membros de uma organização do provedor, organização do consumidor, Catálogo ou Espaço. O subcomando padrão é `list`.	`apic members` - operações de Membro `apic members:clear` -Excluir todos os membros `apic members:create` - cria um membro `apic members:delete` - Excluir um membro por nome ou ID `apic members:get` - Obter um objeto membro por nome ou ID `apic members:list` - Listar todos os membros `apic members:update` - atualiza o membro por nome ou ID
`apic member-invitations`	Listar e gerenciar convites de membros. Um convite de membro é criado quando um usuário é convidado para ser um membro de uma organização do provedor, uma organização do consumidor, um Catálogo ou um Espaço. O subcomando padrão é `list`.	`apic member-invitations` - operações de coleta de convite de membro. `apic member-invitations:clear` - excluir todos os convites de membro. `apic member-invitations:create` - criar um convite de membro. `apic member-invitations:delete` - excluir um convite de membro por nome ou ID. `apic member-invitations:get` - Obter um objeto de convite de membro por nome ou ID. `apic member-invitations:list` - listar todos os convites de membro. `apic member-invitations:update` - atualizar um convite de membro por nome ou ID.
`apic orgs`	Listar e gerenciar organizações do provedor e a organização do administrador. O subcomando padrão é `list`.	`apic orgs` - operações de coleta de Organização `apic orgs:clear` - Excluir todas as organizações `apic orgs:create` - Criar uma organização `apic orgs:delete` - Excluir uma organização por nome ou ID `apic orgs:get` - Obter um objeto da organização por nome ou ID `apic orgs:list` - Listar todas as organizações `apic orgs:transfer-owner` - Transferir a propriedade de uma organização `apic orgs:update` - Atualizar uma organização por nome ou ID
`apic org-settings`	Gerenciar configurações para organizações do provedor, e a organização admin.	`apic org-settings:get` - Obter o objeto de configurações para uma organização `apic org-settings:update` - Atualizar as configurações para uma organização
`apic policies`	Listar e gerenciar políticas em um catálogo. O subcomando padrão é `list`.	`apic policies` - operações de coleta de Política `apic policies:clear` - limpa as Políticas `apic policies:clear-all` - limpa todas as Políticas em todas as coletas `apic policies:create` - cria uma Política `apic policies:delete` - exclui uma Política `apic policies:get` - obtém a Política por nome e versão `apic policies:list` - lista as Políticas `apic policies:list-all` - lista todas as Políticas em todas as coletas `apic policies:update` - atualiza a Política por nome e versão
`apic products`	Listar e gerenciar Produtos que são montados ou publicados no Catálogo ou Espaço. O subcomando padrão é `list-all`.	`apic products` - operações de coleta de Produto `apic products:clear` - Excluir todas as versões de um Produto por nome `apic products:clear-all` - Excluir todos os Produtos `apic products:delete` - Excluir um Produto por nome e versão `apic products:execute-migration-target` - os Produtos executam operações de destino de migração `apic products:get` - Obter um objeto de Produto por nome e versão `apic products:list` - Listar todas as versões de um Produto por nome `apic products:list-all` - Listar todos os Produtos `apic products:publish` - Publicar um Produto em um Catálogo ou Espaço, fornecendo o arquivo YAML de definição de Produto `apic products:replace` -Substitua um Produto com outro Produto `apic products:set-migration-target` - Configurar o Produto de destino para migrar assinaturas de um Produto `apic products:supersede` - Suplantar um Produto com outro Produto `apic products:update` - Atualizar um Produto por nome e versão, fornecendo o arquivo YAML de definição de Produto revisado
`apic identity-providers`	Visualizar informações sobre os provedores de identidade.	`apic identity-providers` - operações do provedor de identidade `apic identity-providers:list` - listar os provedores de identidade.
`apic spaces`	Listar e gerenciar Espaços contidos em um catálogo. O subcomando padrão é `list`.	`apic spaces` -operações de coleta de Espaço `apic spaces:clear` - Excluir todos os Espaços de um Catálogo `apic spaces:create` - Criar um Espaço em um Catálogo `apic spaces:delete` - Excluir um Espaço de um Catálogo por nome ou ID `apic spaces:get` - Obter um objeto de Espaço por nome ou ID `apic spaces:list` - Listar todos os Espaços em um Catálogo `apic spaces:transfer-owner` - Transferir a propriedade de um Espaço para outro usuário `apic spaces:update` - Atualizar um Espaço por nome ou ID
`apic subscriptions`	Listar e gerenciar assinaturas em um produto ou em um catálogo. O subcomando padrão é `list`.	`apic subscriptions` - operações de coleta de Assinatura `apic subscriptions:clear` - limpa as Assinaturas `apic subscriptions:create` - cria uma Assinatura `apic subscriptions:delete` - exclui a Assinatura por nome ou ID `apic subscriptions:get` - obtém a Assinatura por nome ou ID `apic subscriptions:list` - lista as Assinaturas `apic subscriptions:update` - atualiza a Assinatura por nome ou ID

Tabela 3. Resumo de outros comandos para desenvolvedores e gerenciadores de API
Comando	Descrição	Subcomandos
`apic consumer-orgs`	Gerenciar organizações do consumidor	`apic consumer-orgs` - operações de coleta de Organização do Consumidor. `apic consumer-orgs:clear` - limpa as Organizações do Consumidor. `apic consumer-orgs:create` - cria uma Organização do Consumidor. `apic consumer-orgs:delete` - exclui a Organização do Consumidor por nome ou ID. `apic consumer-orgs:get` - obtém a Organização do Consumidor por nome ou ID. `apic consumer-orgs:list` - lista as Organizações do Consumidor. `apic consumer-orgs:transfer-owner` - transfere o proprietário para um novo membro. `apic consumer-orgs:update` - atualiza a Organização do Consumidor por nome ou ID.
`apic consumer-org-settings`	Gerencie configurações da organização do consumidor	`apic consumer-org-settings:delete` - exclui a Configuração da Organização do Consumidor. `apic consumer-org-settings:get` - obtém a Configuração da Organização do Consumidor. `apic consumer-org-settings:update` - atualiza a Configuração da Organização do Consumidor.
`apic groups`	Gerenciar grupos	`apic groups` - operações de coleta de grupo. `apic groups:clear` - limpa os Grupos. `apic groups:create` - cria um Grupo. `apic groups:delete` - exclui o Grupo por nome ou ID. `apic groups:get` - obtém o Grupo por nome ou ID. `apic groups:list` - lista os Grupos. `apic groups:update` - atualiza o Grupo por nome ou ID.
`apic invitations`	Gerenciar convites. Um convite é criado quando um usuário é convidado para ser o proprietário de uma organização do provedor, organização do consumidor, Catálogo ou Espaço.	`apic invitations` - Operações de coleta de convite. `apic invitations:clear` - Excluir todos os convites. `apic invitations:create` - Criar um convite. `apic invitations:delete` - Excluir um convite por nome ou ID. `apic invitations:get` - Obter os detalhes de um convite por nome ou ID. `apic invitations:list` - Listar todos os convites. `apic invitations:update` - Atualizar um convite por nome ou ID.
`apic member-invitations`	Gerenciar convites de membros. Um convite de membro é criado quando um usuário é convidado para ser um membro de uma organização do provedor, uma organização do consumidor, um Catálogo ou um Espaço.	`apic member-invitations` - operações de coleta de convite de membro. `apic member-invitations:clear` - excluir todos os convites de membro. `apic member-invitations:create` - criar um convite de membro. `apic member-invitations:delete` - excluir um convite de membro por nome ou ID. `apic member-invitations:get` - Obter os detalhes de um convite de membro por nome ou ID. `apic member-invitations:list` - listar todos os convites de membro. `apic member-invitations:update` - atualizar um convite de membro por nome ou ID.
`apic members`		`apic members` - operações de coleta de Membro. `apic members:clear` - limpa os Membros. `apic members:create` - cria um Membro. `apic members:delete` - exclui o Membro por nome ou ID. `apic members:get` - obtém o membro por nome ou ID. `apic members:list` - lista os Membros. `apic members:update` - atualiza o Membro por nome ou ID.
`apic registrations`		`apic registrations` - operações de coleta de Registro. `apic registrations:clear` - limpa os Registros. `apic registrations:create` - cria um Registro. `apic registrations:delete` - exclui o Registro por nome ou ID. `apic registrations:get` - obtém o Registro por nome ou ID. `apic registrations:list` - lista os Registros. `apic registrations:update` - atualiza o Registro por nome ou ID.
`apic role-defaults`		`apic role-defaults` - operações de coleta de Padrão de Função. `apic role-defaults:clear` - limpa os Padrões de Função. `apic role-defaults:create` - cria um Padrão de Função. `apic role-defaults:delete` - exclui o Padrão de Função por nome ou ID. `apic role-defaults:get` - obtém o Padrão de Função por nome ou ID. `apic role-defaults:list` - lista os Padrões de Função. `apic role-defaults:list-all` - lista todos os Padrões de Função em todas as coletas. `apic role-defaults:update` - atualiza o Padrão de Função por nome ou ID.
`apic roles`		`apic roles` - operações de coleta de Função. `apic roles:clear` - limpa as Funções. `apic roles:create` - cria uma Função. `apic roles:delete` - exclui a Função por nome ou ID. `apic roles:get` - obtém a Função por nome ou ID. `apic roles:list` - lista as Funções. `apic roles:update` - atualiza a Função por nome ou ID.
`apic tasks`		`apic tasks` - operações de coleta de Tarefa. `apic tasks:clear` - limpa as Tarefas. `apic tasks:create` - cria uma Tarefa. `apic tasks:delete` - exclui a Tarefa por nome ou ID. `apic tasks:get` - obtém a Tarefa por nome ou ID. `apic tasks:list` - lista as Tarefas. `apic tasks:update` - atualiza a Tarefa por nome ou ID.
`apic user-registries`		`apic user-registries` - Operações de coleta do registro do usuário. `apic user-registries:clear` - Limpar os registros do usuário. `apic user-registries:create` - Criar um registro do usuário. `apic user-registries:delete` - Excluir o registro do usuário por nome ou ID. `apic user-registries:execute` - Executar uma operação do registro do usuário. `apic user-registries:get` - Obter o registro do usuário por nome ou ID. `apic user-registries:list` - Listar os registros do usuário. `apic user-registries:search` - procurar usuários em um registro do usuário. `apic user-registries:test-connection` - Testar uma conexão do registro do usuário. `apic user-registries:update` - Atualizar o registro do usuário por nome ou ID.
`apic user-registry-settings`		`apic user-registry-settings:delete` - exclui a Configuração de Registro do Usuário. `apic user-registry-settings:get` - Obter a configuração do registro do usuário. `apic user-registry-settings:update` - Atualizar a configuração do registro do usuário.
`apic users`		`apic users` - Operações de coleta do usuário. `apic users:clear` - Limpar os usuários. `apic users:create` - Criar um usuário. `apic users:delete` - Excluir o usuário por nome ou ID. `apic users:get` - Obter o usuário por nome ou ID. `apic users:list` - Listar o usuários. `apic users:request-password-reset` - enviar um link de reconfiguração de senha. `apic users:search-provider` - procurar usuários do provedor de uma organização. `apic users:update` - Atualizar o usuário por nome ou ID.
`apic test`	Teste suas APIs	`apic test {yaml-files}` -Definir os testes `apic test {yaml-files} --insecureSkipVerify` -Teste as APIs com verificações de certificado desativadas. `apic test {yaml-files} --certPath={location of certs folder}` -Especifica o local do certificado de autoridade de certificação se ele não estiver disponível no keystore do sistema. `api test {yaml-files} --mTLS --certPath={location of certs folder}` -Teste as APIs com `mTLS` ativado. `api test {yaml-files} --config-file={location of config file}` -Defina os testes transmitindo a configuração externa