Detalhes de um item do catálogo

Para ver os detalhes de uma API, acesse a tela Discovery e clique no ícone icon visualize, na listagem de itens do catálogo.
destaque para o ícone para acessar a tela de detalhes

Você pode consultar informações gerais da API, bem como suas revisões e os ambientes associados.

Veja sobre os paineis:

paineis que compõem a tela de detalhes

(A) Aba Overview

Este painel traz as seguintes informações sobre a API:

  • O nome, que aparece como o título do painel;

  • Description: descrição;

  • Created At: data e hora de criação;

  • Imported At: data e hora de importação;

  • Updated At: data e hora de atualização;

  • Owner: usuário ou time responsável;

  • Shared with: usuários com quem a API está compartilhada.

  • Tags: tags (etiquetas) associadas.

A partir do painel Overview você pode realizar as seguintes ações:

Trocar o Owner

  1. Owner: para editar quem é o responsável (usuário ou time) pela API, clique em imagem representado uma pessoa (ao lado de Owner) e selecione a opção desejada.

  2. Clique em SAVE

tela para alterar o responsável pela API


Editar Shared with

  1. Para editar com quem a API é compartilhada, clique em imagem representando duas pessoas (ao lado de Shared with) e selecione um ou mais usuários ou times.

  2. Clique em SAVE

tela para alterar os usuários com que a API está compartilhada


Adicionar ou remover tags

Para adicinar uma tag:

  1. Clique no ícone icon tags para adicionar uma tag.

  2. 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 "-".

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

  4. Caso deseje adicionar outra tag, repita os dois últimos passos. Cada API pode conter até 50 tags associadas.

  5. Clique em OK para fechar a janela.

    tela de tag com ênfase para o + para adicionar

    Se clicar em OK sem clicar em + (ou pressionar enter), a tag não será associada/criada.

Para remover uma tag:

  1. Clique no ícone icon tags para adicionar uma tag.

  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.

    tela de tag com ênfase para o x para remover

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

  5. Clique em OK para fechar a janela.

(B) Painel ISSUES com Inteligência Artificial

No painel Issues, são exibidos os problemas que foram detectados por IA e que podem impactar a qualidade das APIs e do ecossistema. São elementos que podem ser ajustados para melhorar aspectos como organização e desempenho.

  • CONSISTENCY: Quality Analysis: 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.

    O gráfico representa o nível de maturidade da API.
    Clique em Go to issue details para ver o Relatório de Maturidade completo e acessar as Smart Recommendations.

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

    O número exibido indica a quantidade de recursos com redundância.
    Clique em Go to issue details para ver a lista completa de redundâncias.

Um campo vazio na coluna ISSUES 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.

(C) Aba DOCUMENTATION

Nesta aba você encontra o Relatório de Maturidade, especificação de API e o botão de acesso para as Smart Recommendations.

(D) Aba DEPLOYMENTS

Nesta aba você encontra informações sobre os ambientes nos quais a API está implantada.

Cada card apresenta as seguintes informações:

  • Nome do ambiente;

  • Endereço;

  • Número da revisão. Clique para ver a especificação, relatório de maturidade e botão para acesso para as Smart Recomendations.

Thanks for your feedback!
EDIT

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