Discovery

A tela Discovery traz um catálogo com suporte a múltiplos gateways que lhe permite centralizar suas APIs, deixando seu ecossistema mais organizado e aumentando o controle sobre ele.

discovery screen
Tela Discovery

Totalizadores

Na parte superior da tela Discovery, você encontra um pequeno dashboard trazendo métricas gerais do seu catálogo:

discovery totalizers

Os totalizadores exibem as métricas conforme os filtros aplicados na tela. Eles são os seguintes:

  • Number of APIs: exibe o número total de APIs no catálogo. Ao clicar no cartão, é possível visualizar o total de APIs por vendor.

  • Uncategorized APIs: total de APIs que não possuem nenhuma tag associada.

  • APIs recently imported: total de APIs importadas ao catálogo em um determinado período de tempo (nos últimos 7 dias, por padrão). É possível alterar o período de tempo considerado:

    1. Clique no botão icon settings do cartão;

    2. Na janela modal que se abrir, selecione o período desejado dentre os seguintes:

      • Yesterday: dia anterior;

      • Last 7 days: últimos 7 dias;

      • Last 15 days: últimos 15 dias;

      • Last 31 days: últimos 31 dias.

    3. Clique no botão OK.

  • APIs recently updated: total de APIs no catálogo atualizadas em um determinado período de tempo (nos últimos 7 dias, por padrão). É possível alterar o período de tempo considerado:

    1. Clique no botão icon settings do cartão;

    2. Na janela modal que se abrir, selecione o período desejado dentre os seguintes:

      • Yesterday: dia anterior;

      • Last 7 days: últimos 7 dias;

      • Last 15 days: últimos 15 dias;

      • Last 31 days: últimos 31 dias.

    3. Clique no botão OK.

Listagem de APIs

As APIs importadas são listadas em uma tabela, em que cada linha corresponde a um item.

Para cada item, as seguintes informações são exibidas (colunas):

  • TYPE: tipo, representado por um ícone;

  • NAME: nome;

  • VENDOR: organização que o gerencia;

  • CURRENT VERSION: versão mais recente;

  • MATURITY: score de maturidade da API conforme a classificação abaixo:

    • Básico: 0 a 29%

    • Intermediário: 30 a 79%

    • Avançado: 80 a 94%

    • Excelente: 95 a 100%

Caso o relatório de maturidade apresente dado de risco, você verá um ícone de alerta ao lado do score. Ao passar o mouse sobre o ícone, uma mensagem sobre o risco será exibida.

  • TAGS: tags associadas.

É possível ordenar a lista (em ordem crescente ou decrescente) pelo nome das APIs, clicando no texto do cabeçalho da coluna NAME.

A coluna ACTIONS contém os seguintes botões:

icon visualize: permite visualizar detalhes sobre o item correspondente, como os dados gerais, revisões e ambientes associados;

icon tags: permite associar tags ao item correspondente, bem como gerenciar as já associadas.

Filtrando a lista

Para filtrar a lista, veja as opções acima da tabela de listagem de itens do catálogo.

Para expandir os campos de filtragem, clique no ícone icon expand. Você encontrará estes campos de filtragem:

  • Name: permite filtrar pelo nome do item.

  • Tag Mode: selecione o critério a ser utilizado na filtragem por tags:

    • Any of selected: exibe as APIs que têm associadas pelo menos uma das tags selecionadas no campo Tags (padrão);

    • All of selected: exibe as APIs que têm associadas todas as tags selecionadas no campo Tags;

    • None of selected: exibe as APIs que não possuem nenhuma das tags selecionadas no campo Tags;

    • No tag applied: exibe as APIs que não possuem tags associadas.

  • Tags: permite filtrar as APIs pelas tags associadas a elas, de acordo com o critério selecionado no campo Tag Mode.

  • Vendor: filtra por organização gerenciadora.

  • Imported At: filtra pelo dia da importação da API.

  • Updated At: filtra pelo dia da atualização da API.

  • Version: filtra pela versão mais recente.

  • Description: permite filtrar considerando a descrição do item.

Após informar os valores para os campos desejados, clique em SEARCH para realizar a filtragem, ou em CLEAR para limpar os campos preenchidos.

Categorização por tags

A categorização por tags permite que você classifique e agrupe as APIs do catálogo por meio de etiquetas personalizáveis, tornando mais fácil e rápida a gestão das suas APIs. Essa funcionalidade possibilita que você busque por APIs de uma mesma categoria utilizando suas tags.

Associar uma tag a uma API

Para associar uma tag a uma API do catálogo, siga estes passos:

  1. Na listagem de APIs da tela Discovery, clique no botão icon tags correspondente à API à qual deseja associar a tag.

  2. Caso a API selecionada ainda não possua uma tag associada, uma janela modal contendo uma mensagem se abrirá. Nessa janela, clique em ADD.

  3. No campo Tag Name, digite o nome da tag que deseja associar (novo ou já cadastrado previamente). O nome de uma tag deve conter no mínimo 2 e no máximo 30 caracteres. São aceitos apenas caracteres alfanuméricos minúsculos e "-" (porém, o nome não pode começar ou terminar com "-").

  4. Clique em + (ou pressione ENTER) para associar a tag.

  5. Caso deseje adicionar outra tag, repita os dois últimos passos. Cada API pode conter até 50 tags associadas e o nome de cada tag deve ser único.

  6. Clique em OK para fechar a janela modal.

Caso a API já possua uma ou mais tags associadas, também será possível associar novas tags a ela por meio da tela de detalhes:

  1. Na listagem de APIs da tela Discovery, clique no botão icon visualize correspondente à API à qual deseja associar a tag.

  2. Clique no botão icon pencil localizado no campo Tags do painel GENERAL DATA.

  3. Siga os passos 3 a 6 descritos acima.

Remover tags de uma API

Para desassociar uma ou mais tags de uma API do catálogo, siga os seguintes passos:

  1. Na listagem de APIs da tela Discovery, clique no botão icon tags correspondente à API da qual deseja desassociar a(s) tag(s).

  2. Na janela modal que se abrir, localize a tag que deseja desvincular da API.

  3. Clique no botão X dessa tag para removê-la.

  4. Caso deseje remover outra tag dessa API, repita os dois últimos passos.

  5. Clique em OK para fechar a janela modal.

Também é possível desassociar tags a partir da tela de detalhes da API desejada:

  1. Na tela de detalhes da API desejada, clique no botão icon pencil localizado no campo Tags do painel GENERAL DATA.

  2. Siga os passos 2 a 5 descritos acima.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]