Thanks for your feedback!
EDIT
Detalhes de um item do catálogo
Veja os detalhes de uma API acessando a tela Discovery.
Para isso, clique no ícone 
, na listagem de itens do catálogo.
Você pode consultar informações gerais da API, bem como suas revisões e os ambientes associados.
Veja sobre os paineis:
-
(A) Basic info (informações básicas)
-
(B) Revisions (revisões)
-
(C) Deployments (implantações)
-
(D) Issues e Quality Analysis (problemas e análise de qualidade)
(A) Basic info
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;
-
Version: versão mais recente;
-
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 Basic info você pode realizar as seguintes ações:
-
Trocar o Owner (usuário ou time responsável pela API);
-
Editar Shared with (usuários ou times com quem a API está compartilhada);
Trocar o Owner
-
Owner: para editar quem é o responsável (usuário ou time) pela API, clique em
(ao lado de Owner) e selecione a opção desejada. -
Clique em SAVE
Editar Shared with
-
Para editar com quem a API é compartilhada, clique em
(ao lado de Shared with) e selecione um ou mais usuários ou times. -
Clique em SAVE
Adicionar ou remover tags
Para adicinar uma tag:
-
Clique no ícone
para adicionar uma tag. -
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.
-
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.
Se clicar em OK sem clicar em + (ou pressionar enter), a tag não será associada/criada.
Para remover uma tag:
-
Clique no ícone
para adicionar uma tag. -
Na janela que se abrir, localize a tag que deseja desvincular da API.
-
Clique no botão X dessa tag para removê-la.
-
Caso deseje remover outra tag dessa API, repita os dois últimos passos.
-
Clique em OK para fechar a janela.
(B) Aba REVISIONS
Nesta aba você encontra o histórico de revisões da API.
Colunas da lista de revisões:
-
DESCRIPTION: descrição;
-
DEPLOYED IN SERVER: servidor em que a revisão está implantada;
-
MATURITY: score de maturidade;
-
ACTIONS: acesso ao Relatório de Maturidade e Especificação de API.
(C) Aba DEPLOYMENTS
Nesta aba você encontra informações sobre os ambientes de implantação das APIs.
Colunas da lista de deployments:
-
SERVER NAME: nome do servidor;
-
SERVER URL: endereço do servidor;
-
DEPLOYED REVISION: número ou data da revisão vigente no servidor.
Quando não houver revisão da API, será exibido um traço ("-") nesta coluna e na coluna de maturidade. -
MATURITY: score de maturidade;
-
ACTIONS: acesso ao Relatório de Maturidade e Especificação de API.
(D) Painel ISSUES e Quality Analysis
Issues
No painel Issues, são exibidos problemas detectados que podem impactar a qualidade das APIs e do ecossistema.
Elementos que podem ser ajustados para melhorar aspectos como organização e desempenho serão destacados e listados nesse espaço.
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.
Quality Analysis
Este painel exibe o score de maturidade da API.
Clique em Go to issues details (vá para detalhes do problema) para ver o Relatório de Maturidade e Especificação de API e para acessar as Smart Recommendations.
Share your suggestions with us!
Click here and then [+ Submit idea]