Incluindo uma API REST importando um arquivo de definição OpenAPI

É possível usar um arquivo de definição OpenAPI para importar uma API REST no IBM® API Connect.

Antes de Iniciar

Seu arquivo deve estar em conformidade com a versão 2.0 ou versão 3.0 da especificação OpenAPI . O formato do arquivo pode ser JSON ouYAML.

Nota: produtos que contêm uma API com uma propriedade Swagger usando regex que incluem asserções lookahead, como "(?" não podem ser validados ou publicados. Uma mensagem de erro é retornada. Por exemplo:

Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400

Sobre essa tarefa

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

API Manager Somente IU: para concluir essa tarefa, deve-se estar designado a uma função que tenha as permissões Api-Drafts:Edit, Settings:View, e App:View .. A função de Desenvolvedor que é fornecida previamente tem essas permissões por padrão; se você receber uma função customizada, ela deve ter essas permissões. Para obter mais informações, consulte Criando funções customizadas

Se você estiver usando a IU do API Designer e desejar usar um arquivo de definição OpenAPI de outro lugar, transferido por download de um website externo, por exemplo, em vez de ser criado usando API Connect, use o mecanismo de importação descrito aqui em vez de copiar o arquivo em seu diretório local do API Designer ; a operação de importação inclui API Connect seções específicas que são necessárias pelo API Designer.

Procedimento

Para incluir uma API REST importando um arquivo OpenAPI , conclua as etapas a seguir:

No painel de navegação, clique em Desenvolvimento e, em seguida, clique em Adicionar > API.
A tela Selecionar tipo de API é exibida.
Selecione OpenAPI 2.0 ou OpenAPI 3.0 de acordo com a versão da especificação OpenAPI na qual sua API deve ser baseada.
Na seção Importar, selecione OpenAPI existente e clique em Next.
Escolha um dos métodos a seguir para importar o arquivo:
- Arraste e solte um arquivo
  Abrir outra janela, selecionar um arquivo. Arraste o arquivo para a caixa Selecionar um arquivo e libere o arquivo
- Procure um arquivo
  Clique na caixa Selecionar um arquivo .. Localize o arquivo e selecione-o
- Especifique o endereço URL de um arquivo
  No campo Ou especifique um arquivo URL, digite ou cole um URL para o arquivo. Opcionalmente, inclua um Nome do usuário e Senha se forem necessários para acessar o arquivo.
Os tipos de arquivo a seguir são suportados se contiverem uma definição válida do OpenAPI : .json, .ymle .yaml..
Clique em Avançar para importar o arquivo selecionado.
O assistente verifica a validade do YAML e exibe uma mensagem indicando uma validação bem-sucedida.
Notas:
- Se você estiver usando a IU do API Manager , a operação de importação falhará se o arquivo definir uma API que tenha o mesmo nome e versão que uma definição de API existente. No entanto, se você estiver usando a IU do API Designer , as definições de API serão identificadas exclusivamente pelo nome do arquivo em seu sistema de arquivos local; portanto, se você importar dois arquivos diferentes que definem o mesmo nome e versão da API, duas definições de API com o mesmo nome e versão serão criadas no API Connect, sem erro,
- Quaisquer mensagens de erro de validação são exibidas apenas em inglês, e não são traduzidas.
Opcional: Selecione “Ativar API” se desejar usar imediatamente a API para desenvolvimento e testes adicionais.
Nota:
- Ao selecionar a opção Ativar API , o API Connect conclui automaticamente as ações a seguir:
  - Cria um Produto de rascunho, inclui a API no Produto e publica o Produto no Catálogo de ambiente de simulação para que a API fique disponível para ser chamada. O Produto tem o título Produto automático api_title. Este Produto não é visível na visualização Desenvolver e não é possível excluí-lo diretamente. No entanto, se você excluir a API, o rascunho do produto será excluído junto com a API; consulte Excluindo uma definição de API. O Produto é visível em quaisquer Catálogos nos quais é publicado. Se você quiser remover o produto de um catálogo, é necessário fazer isso separadamente; consulte Remoção de um produto de um catálogo
  - Inscreve o Aplicativo de teste de ambiente de simulação no Produto para que a API possa ser imediatamente testada no ambiente de teste. Para obter informações sobre o teste de uma API, consulte Testando uma API
- Não é possível usar a opção “Ativar API” se a aprovação do ciclo de vida estiver ativada no catálogo do Sandbox para as ações “Preparar”, “Publicar” ou “Substituir”. Se alguma dessas aprovações de ciclo de vida estiver ativada, será necessário desativá-las para poder usar a opção da API Activate; para obter informações sobre as configurações de aprovação de ciclo de vida, consulte Criação e configuração de catálogos.
- Para usar a opção Ativar API , deve-se ter designada uma função que tenha as permissões Product:Manage e Subscription:Manage . A função de Desenvolvedor que é fornecida previamente tem essas permissões por padrão; se você receber uma função customizada, ela deve ter essas permissões. Para obter mais informações, consulte Criando funções customizadas
Clique em Avançar. O painel Importar Resumo da API indica que o arquivo YAML é carregado e válido.

Se você selecionou Ativar API, o assistente preencherá uma URL de Terminal da API e exibirá um ID de Cliente e Segredo do Cliente que poderão ser usados.
Selecione uma das seguintes opções:
- Para configurar ainda mais sua API, clique em Editar API. Para obter detalhes, consulte Editando uma definição de API.
- Se não quiser continuar configurando sua API no momento, clique no link Desenvolver na trilha de navegação para retornar à página de boas-vindas e, em seguida, será possível migrar imediatamente para outra tarefa. Para obter detalhes sobre como configurar sua API posteriormente, consulte Editando uma definição de API..

Resultados

Quando a definição de API é importada, ela é mostrada na lista de definições de API na página Desenvolver. Para o API Designer, as especificações para as APIs e Produtos são armazenadas no diretório especificado quando você efetuou login. Para o API Manager, as especificações para as APIs e Produtos são armazenadas no servidor de gerenciamento.

O quê fazer em seguida

As APIs são disponibilizadas para desenvolvedores de aplicativos incluindo-os em um Produto e, em seguida, publicando esse Produto em um Catálogo. Para obter mais informações, consulte “Trabalhando com produtos” e “Trabalhando com catálogos ”.