Revisando suas APIs descobertas

Editar online

Como revisar os documentos OpenAPI descobertos em seu recurso de descoberta de API .

Antes de Iniciar

Uma das funções a seguir é necessária para ser capaz de editar APIs descobertas:
  • Administrador da organização
  • Proprietário
  • Função customizada com qualquer uma das permissões a seguir:
    • Configurações: Gerenciar
    • Desenhos de API: Editar
Uma função customizada com a permissão Configurações: Visualizar ou Rascunhos: Visualizar pode visualizar APIs descobertas.

Sobre essa tarefa

A descoberta de API é um complemento do site IBM® API Connect que pode ser usado para descobrir e adicionar APIs ao seu processo de desenvolvimento de API. Depois que um coletor de origem é adicionado ao recurso de descoberta de API, você pode gerenciar os documentos descobertos OpenAPI no API Manager.

Procedimento

Para gerenciar seus documentos OpenAPI descobertos, conclua as etapas a seguir.
  1. Na interface do usuário do API Manager, clique no ícone O ícone de descoberta é o contorno de um par de binóculos em branco sobre um fundo preto.Descobrir e certifique-se de que a guia APIs esteja selecionada.
  2. A lista de documentos do OpenAPI descobertos é exibida na tabela Os documentos OpenAPI na lista são atualizados de acordo com as definições de configuração em sua origem.
    Os documentos OpenAPI podem ter um dos estados a seguir:
    • descoberto -o documento OpenAPI é descoberto pela origem.
    • Copiado para rascunhos -o documento OpenAPI é copiado para a guia APIs na seção Desenvolver da IU do API Manager .
  3. Para visualizar os metadados de um documento do OpenAPI, clique no ícone Opções O ícone de opções é um conjunto de três pontos pretos verticais em um fundo branco. ao lado do documento que deseja examinar e selecione Exibir metadados.
    Uma breve descrição da API é exibida.. É possível então clicar em Visualizar API para visualizar o documento OpenAPI completo ou clicar em Ocultar API para ocultar a API na lista.
  4. Para visualizar o documento OpenAPI completo, Clique no título do documento na tabela APIs .

    Uma versão somente leitura do documento OpenAPI completo é exibida, que é possível explorar na UI. Também é possível fazer o download do documento OpenAPI como um arquivo JSON ou YAML

  5. Para copiar um documento OpenAPI em uma API de rascunho, é possível usar um dos métodos a seguir:
    • Na lista de documentos disponíveis do OpenAPI na guia APIs, clique no ícone Opções O ícone de opções é um conjunto de três pontos pretos verticais em um fundo branco. ao lado do documento que deseja copiar e selecione Copiar para rascunho.
    • Em um documento do OpenAPI , clique em Copiar para rascunho.

    Em seguida, é possível clicar na guia APIs na seção Desenvolver da IU do API Manager e seu documento copiado é mostrado na lista de APIs Agora você pode editar e gerenciar o ciclo de vida dessa API no API Manager; para obter mais informações, consulte a lista de verificação para desenvolvimento de APIs e Trabalhando com definições de API.

  6. Opcional: você pode clicar no ícone de Opções O ícone de opções é um conjunto de três pontos pretos verticais em um fundo branco. ao lado de um documento do OpenAPI para realizar mais ações no documento. As opções a seguir estão disponíveis:
    • Download -para fazer download da API.
    • Visualizar metadados -para visualizar uma breve descrição da API.
    • Copiar para rascunho -para copiar o documento em uma API de rascunho
    • Ocultar API -para ocultar o documento da lista de APIs. É possível exibir as APIs ocultas clicando no ícone Filtros O ícone de filtro é um símbolo em forma de funil com uma parte superior larga e uma parte inferior estreita, selecionando APIs ocultas na categoria Mostrar e clicando em Aplicar. Em seguida, é possível selecionar a opção Mostrar API no documento que você deseja exibir novamente. Para ver a API, deve-se então mudar o filtro para limpar a caixa de seleção APIs ocultas .
    • Remover API -para remover o documento da lista de APIs. Se a API foi copiada para rascunhos, a API será removida apenas da lista de APIs descobertas; ela não será removida da lista de APIs de rascunho. Uma API removida poderá ser descoberta novamente se ainda existir na origem. Se desejar remover um documento da API da lista e não descobri-lo, será possível selecionar a opção Ocultar API .
  7. Opcional: você pode clicar no ícone “Gerenciar O ícone gerenciar colunas é um contorno de uma roda em preto sobre um fundo branco. colunas” no cabeçalho da tabela para alterar a ordem e a exibição das colunas.

Resultados

Você revisou seus documentos descobertos do OpenAPI e copiou as APIs necessárias para rascunhos para ativar o gerenciamento completo do ciclo de vida da API no API Manager..