Publicando APIs e aplicativos

Editar online

Para publicar APIs e aplicativos usando o kit de ferramentas do desenvolvedor do IBM® API Connect, configure variáveis de configuração para definir onde deseja publicar, efetuar login na plataforma de nuvem de destino e, em seguida, usar os comandos de publicação apropriados.

Consulte as seguintes seções para obter mais informações:

Definindo variáveis de configuração

O comando apic config fornece variáveis de configuração globais e baseadas em projeto que especificam o Catálogo de destino para publicar APIs e aplicativos. Os valores dessas variáveis são armazenados em ~/.apiconnect/config (para variáveis globais) e project-dir/.apiconnect (para variáveis do projeto). Para obter uma lista completa das variáveis de configuração, consulte a Visão geral da ferramenta de linha de comando.

Configure a variável de configuração catalog para o URI de um catálogo do API Connect para definir um destino de catálogo padrão para todos os comandos que gerenciam Catálogos. O URI catalog tem o formato:

https://mgmt_endpoint_url/api/catalogs/org_name/catalog_name

em que mgmt_endpoint_url é a URL do terminal da API da plataforma, org_name é o nome da organização do provedor e catalog_name é o nome do catálogo. A parte mgmt_endpoint_url configura o valor padrão da opção --server, a parte org_name configura o valor padrão da opção --org e a parte catalog_name configura o valor padrão da opção --catalog; é possível substituir qualquer um desses valores, incluindo a opção correspondente em um comando.

Configure a variável de configuração space para o URI de um API Connect Espaço, para definir um destino Espaço padrão para todos os comandos que gerenciam Espaços. O URI space possui o formato:
https://mgmt_endpoint_url/api/spaces/org_name/catalog_name/space_name
em que mgmt_endpoint_url é o URL do ponto de extremidade da API da plataforma, org_name é o nome da organização do provedor, catalog_name é o nome do catálogo e space_name é o nome do espaço. A parte mgmt_endpoint_url configura o valor padrão da opção --server, a parte org_name configura o valor padrão da opção --org, a parte catalog_name configura o valor padrão da opção --catalog e o space_name configura o valor padrão da opção --space; é possível substituir qualquer um desses valores, incluindo a opção correspondente em um comando.

Embora a definição dessas variáveis de configuração não seja necessária, isso simplifica os comandos que interagem com as nuvens do API Connect , fornecendo valores padrão para opções da linha de comandos usadas frequentemente.

A seguir está um exemplo de publicação com e sem a variável de configuração catalog configurada.

Sem o conjunto de variáveis de configuração:

apic products publish climb-on.yaml --server mgmnthost.com --org climbon --catalog sandbox

Com o conjunto de variáveis de configuração:

apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
catalog: https://platform-api.myserver.com/api/catalogs/climbon/sandbox
apic products publish climb-on.yaml

É possível substituir os valores padrão fornecidos pela variável de configuração catalog, fornecendo uma das opções padrão com um valor diferente. Por exemplo, use a opção --catalog com o comando apic products publish para especificar o catálogo qa:

 apic products publish climb-on.yaml --catalog qa

Não se esqueça das variáveis de configuração global. Se você usar o mesmo catálogo como o destino padrão para múltiplos projetos, configure o valor globalmente:

 apic config:set --global catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox
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.

Fazendo login em API Connect

Use os comandos apic login e apic logout para gerenciar sua autenticação. Para mais informações, consulte rapic_cli_login.html.

Publicando APIs

A publicação de APIs em catálogos de APIs nas API Connect nuvens permite que você divulgue as APIs por meio do Catálogo do Consumidor e as proteja usando o Gateway.

Um API Product (ou simplesmente Product) é usado para editar APIs para publicação. Os gerentes de produto de API podem usá-la para agrupar uma ou mais APIs, controlar a visibilidade do produto no Catálogo do Consumidor (por exemplo, permitir que apenas os parceiros x, y e z visualizem e se inscrevam no produto) e definir planos para oferecer opções de consumo. Os Produtos que referenciam as APIs e definem os Planos de consumo também são a unidade primária de gerenciamento de ciclo de vida para APIs.

Use o comando apic products publish (equivalente a apic products:publish) para publicar Produtos de API em uma cloud do API Connect .. O exemplo a seguir demonstra como criar APIs editadas por um produto e publicar o produto e suas APIs em um catálogo:

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"
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 provider/default-idp-2
apic products publish climb-on.yaml

Para obter todos os detalhes sobre como fazer login no servidor de gerenciamento a partir da CLI, consulte “Fazendo login em um servidor de gerenciamento ”.

Inclua a opção --stage em apic publish para preparar o produto em um catálogo em vez de publicá-lo. Os produtos em um Catálogo podem estar nos estados a seguir: preparado, publicado, descontinuado ou obsoleto. Por exemplo:

apic products publish --stage climb-on.yaml

É 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 é, em termos conceituais, semelhante a um subcatálogo, com a diferença de que os Produtos e as APIs em todos os Espaços dentro de um Catálogo são publicados no mesmo Catálogo do Consumidor. Para obter mais informações sobre o Spaces, consulte “Usando a sindicação” em IBM API Connect.

Se os valores de configuração padrão tiverem sido configurados para o Espaço, Catálogo, organização e servidor de gerenciamento, o seguinte comando de publicação poderá ser usado:
apic products publish --scope space product.yaml
em que product é o nome do produto que você deseja publicar.
Nota: se o arquivo OpenAPI que define sua API usar um campo $ref para referenciar um fragmento do código OpenAPI definido em um arquivo separado, o campo $ref será substituído pelo conteúdo do arquivo de destino antes que o Produto que contém a API seja preparado ou publicado com o comando apic publish . Para obter mais informações, consulte Usando $ref para reutilizar fragmentos de código em seus arquivos OpenAPI..