Discovery

Em Discovery você tem uma visão geral das principais informações das suas APIs.
Este catálogo de APIs conta com suporte a múltiplos gateways, permitindo maior controle e organização do seu ecossistema.

Links rápidos

Veja como:

Fazer uma busca
Adicionar uma tag a uma API
Remover uma tag de uma API
Aplicar uma edição em várias APIs
Ver o grau de maturidade da API
Obter Smart Recommendations (baixar os contratos já com as alterações recomendadas aplicadas)

Totalizadores

Na parte superior da tela Discovery, você encontra um dashboard com métricas do seu catálogo, conforme os filtros aplicados.

Number of APIs: exibe o número total de APIs no catálogo.
Clique no cartão para ver uma representação gráfica com o total de APIs categorizadas por provedor.
Uncategorized APIs: total de APIs que não possuem tag associada.
APIs recently imported: total de APIs importadas para o catálogo nos últimos 7 dias. Veja como alterar o período.
APIs recently updated: total de APIs no catálogo atualizadas nos últimos 7 dias. Veja como alterar o período:
Para alterar o período de APIs recently imported ou de APIs recently updated:
1. Clique no ícone do cartão;
2. Selecione o período desejado:
  
  Yesterday: dia anterior;
  
  Last 7 days: últimos 7 dias;
  
  Last 15 days: últimos 15 dias;
  
  Last 31 days: últimos 31 dias.
3. Clique em OK.

Listagem de APIs

As APIs importadas são listadas em uma tabela com as seguintes colunas:

catálogo de APIs

PROVIDER: ícone que identifica o provedor do gateway (exemplos: Sensedia, AWS, entre outros)
NAME: nome da API;
VERSION: versão atual;
OWNER: clique em e selecione uma das opções:
- View owner: para ver o responsável pelas APIs, podendo ser um time ou usuário;
- View shared with: para ver com quem as APIs estão compartilhadas.
MATURITY: score de maturidade da API, podendo ser:

Ícone Nível Faixa

Básico

0 a 29%

Intermediário

30 a 79%

Avançado

80 a 94%

Excelente

95 a 100%

Obtenha o relatório de maturidade completo e recomendações geradas por inteligência artificial, com a opção de baixar o Swagger com as recomendações aplicadas.

Ícone	Nível	Faixa
	Básico	0 a 29%
	Intermediário	30 a 79%
	Avançado	80 a 94%
	Excelente	95 a 100%

ISSUES: indica a existência de problemas que possam interferir na qualidade das API e do seu ecossistema. Identifica a presença de elementos que podem ser alterados para aprimorar aspectos como, por exemplo, organização e desempenho.
Tipos de Issues mais comuns:

Consistency: relacionado à consistência e organização das APIs. Indica a existência de violações de boas práticas em contratos OpenAPI. Verifica se os contratos estão completos e consistentes, garantindo que o desenvolvimento e a documentção estejam alinhados com as regras da organização.

Efficiency: relacionado ao uso dos recursos. Indica a presença de redundâncias e oportunidades de otimização. Não abrange aspectos relacionados ao desempenho.

Um campo vazio na coluna ISSUES, logo após a importação, não indica necessariamente a ausência de problemas.
Após a importação, as APIs precisam ser processadas e o tempo para a geração das Issues pode variar de minutos a algumas horas, dependendo da quantidade de APIs e do tamanho dos contratos importados.

TAGS: tags (etiquetas). Veja como funcionam as tags.
ACTIONS:
- : ver detalhes sobre o item correspondente, como os dados gerais, revisões e ambientes associados;
- : adicionar tags ao item correspondente ou gerenciar as já existentes.

Buscando por API

Para ver todas as opções de filtragem, clique no ícone .

Você pode buscar as APIs por:

Name: nome da API.
Tags: tags (etiquetas). Selecione ou digite o nome da tag. Veja como funcionam as tags.
Utileze o campo Tag Mode para definir o critério de busca das tags:
- Any of selected: APIs que têm pelo menos uma das tags selecionadas no campo Tags (padrão);
- All of selected: APIs que têm todas as tags selecionadas no campo Tags;
- None of selected: APIs que não possuem as tags selecionadas no campo Tags;
- No tag applied: exibe as APIs que não possuem tags.
Version: versão da API.
Description: conteúdo do campo de descrição da API.
Provider: provedor do gateway (exemplos: Sensedia, AWS, entre outros).
Connections: nome da conexão.
Owners: responsável (time ou usuário) pela API.
Shared with: time ou usuário com quem a API está compartilhada. Você pode usar um ou mais times ou usuários para realizar a busca.
Imported At: dia da importação da API.
Updated At: dia da última atualização da API.

Após informar os valores para os campos desejados, clique em SEARCH para realizar a busca, 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

Existem dois caminhos para associar uma tag a uma API do catálogo:

Ícone de tags imagem de uma etiqueta

Na listagem de APIs da tela Discovery, clique no ícone da API que deseja categorizar (associar a tag).
Caso a API selecionada ainda não possua uma tag associada, clique em ADD.

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 "-".
O nome da tag não pode começar ou terminar com "-".

Clique em + (ou pressione ENTER no seu teclado) para associar a tag.

Se clicar em OK sem clicar em + (ou pressionar enter), a tag não será associada/criada.
Caso deseje adicionar outra tag, repita os dois últimos passos. Cada API pode conter até 50 tags associadas.
Clique em OK para fechar a janela.

Ícone para ver detalhes
1. Na listagem de APIs da tela Discovery, clique no ícone da coluna ACTIONS da API que deseja categorizar (associar a tag).
2. Clique no ícone localizado ao lado de Tags, no painel BASIC INFO.
3. Siga os passos 3 a 6 descritos acima.

Remover tags de uma API

Existem dois caminhos para desvincular uma ou mais tags de uma API do catálogo:

Ícone de tags
1. Na listagem de APIs da tela Discovery, clique no botão correspondente à API da qual deseja desassociar a(s) tag(s).
2. Na janela 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.

Você também pode desassociar tags a partir da tela de detalhes da API desejada:

Na tela de detalhes da API desejada, clique no botão localizado no campo Tags do painel BASIC INFO.
Siga os passos 2 a 5 descritos acima.

Editando informações da API

Para editar informações de uma API, clique no ícone imagem de uma lupa sobre uma folha de papel .

No painel BASIC INFO, você pode editar:

Owner: para editar quem é o responsável (usuário ou time) pela API, clique em Owner e selecione a opção desejada.
Shared with: para editar com quem a API é compartilhada, clique em Shared with e selecione um ou mais usuários.

Edição em massa

Utilize o recurso de BULK EDIT (edição em massa) para cadastrar a mesma informação para várias APIs com uma única ação.

Para isso, siga estes passos:

Na listagem de APIs da tela Discovery, selecione as APIs que serão editadas.
Para selecionar todas, clique na caixa de seleção ao lado de PROVIDER, na linha que exibe os títulos das colunas.
Clique no botão BULK EDIT.
Você pode editar o Owner (responsável pela API) e Shared with (com quem a API é compartilhada).

Thanks for your feedback!

EDIT

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