Detalhes de um Item do Catálogo

Você pode acessar a tela de detalhes de uma API específica através da tela Discovery. Para isso, clique no ícone icon visualize, na listagem de itens do catálogo.

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

As informações são apresentadas em duas abas: GENERAL DATA e DETAILS.

Aba GENERAL DATA

Esta aba apresenta, na parte superior, um painel com informações gerais sobre a API, no qual você pode consultar:

  • Name: nome;

  • Version: versão mais recente;

  • Description: descrição;

  • API Responsible: usuário responsável;

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

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

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

  • Tags: tags associadas. Se ainda não houver nenhuma, e você quiser adicionar tags, clique no ícone icon tags para adicioná-las e siga os passos abaixo:

    1. 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 "-").

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

    3. 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.

    4. Clique em OK para fechar a janela modal.

No canto superior direito da tela, você visualizará o score de maturidade da sua API (MATURITY), que é definido automaticamente após a sua importação.

discovery general data
Para visualizar o relatório de maturidade da última revisão da API e sua especificação, clique em Latest Revision.

Aba DETAILS

Nesta aba, você poderá ver detalhes da API com base no ambiente de implantação da revisão.

Para isso, selecione um modo de visualização clicando na seta à direita do campo VIEW MODE.

Por padrão, o modo Environments já vem selecionado.

Há dois modos de visualização disponíveis:

Environments

A tabela apresenta as seguintes colunas:

  • DESCRIPTION: nome do environment;

  • URL: host + basepath do environment;

  • DEPLOYED REVISION: número ou data da revisão vigente no environment;

Quando não houver revisão da API implantada em um environment listado, será exibido um traço ("-") e a maturidade ficará com o score zerado.
discovery environments
Revisions
discovery revisions
Thanks for your feedback!
EDIT

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