Exibição de detalhes da API em Insights de APIs
Como arquiteto empresarial, obtenha informações sobre o desempenho, os relacionamentos e a governança da API da sua organização na página de detalhes da API no Insights de APIs espaço.
Acesso e uso da página de detalhes da API
Para acessar a página de detalhes da API, navegue até , selecione APIs E, em seguida, selecione uma API na Nome Da tabela de dados da API.
Exibição de dados
Por padrão, a página exibe os seguintes dados:
- Região do cabeçalho
- Região de metadados
- Listas relacionadas
- Painel de visão geral
- Uso
- Eventos
- Segurança
- Mapa de relacionamento
- Região do cabeçalho
- Exibe o nome da API, as informações da versão e a fase do ciclo de vida atual da API, como Operacional ou Fim da vida útil.
A lista Exibir por permite alternar entre diferentes plataformas de gestão, se disponíveis, nas quais a API é gerenciada.
O seletor de versão permite a seleção de diferentes versões da API para exibir e gerenciar. Selecione Atualizar para atualizar os detalhes com base na versão selecionada.
Nota:A lista Exibir por e o seletor de versão são exibidos apenas se aplicáveis a uma API. - Região de metadados
- Exibe os campos a seguir.
Campo Descrição Descrição Breve resumo ou finalidade da API. Última descoberta em Última data em que a API foi descoberta ou atualizada no CMDB. Origem da descoberta Origem de onde a API foi descoberta. Tipo Tipo de API: REST API com script, HTTP API, plataforma REST API e assim por diante. Grupo responsável Equipe ou grupo responsável por gerenciar a API. Interface digital Método de interação da API no sistema. - Listas relacionadas
- Exibe os seguintes itens como links com suas contagens.
Item Descrição Solicitações de acesso recebidas Exibe o número de solicitações de acesso feitas para a API. Selecione o link exibido no cartão para exibir os detalhes da solicitação de acesso. clientees Exibe o número de consumidores da API. Selecione o link exibido no cartão para exibir detalhes de cada consumidor de API. Implantações Indica implantações ativas ou anteriores da API nos ambientes. Selecione o link exibido no cartão para exibir os detalhes da implantação da API. Produtos Exibe o número de produtos associados à API. Selecione o link exibido no cartão para exibir os detalhes do produto da API. Marcadores Exibe o número de marcadores associados à API. Selecione o link exibido no cartão para exibir os detalhes de cada marcador. - Painel de visão geral
- Lista todos os componentes disponíveis da API, organizados em três subseções no painel Visão geral:
- Front-end
- Contém operações no lado do cliente, incluindo mutações GraphQL e consultas que interagem com a IU ou a funcionalidade voltada para o usuário.
- Back-end
- Contém operações no lado do servidor, incluindo mutações GraphQL específicas de back-end e consultas que processam lógica de negócios e dados.
- Componentes
- Contêm vários endpoints da API REST ou interfaces de serviço, cada um fornecendo uma função ou recurso específico na API.
Você pode expandir cada subseção para exibir seus endpoints e selecionar qualquer endpoint para ver seus detalhes.
- Uso
- Exibe os seguintes cartões.
Cartão Descrição Número médio de solicitações Número de solicitações de componente de API ao longo do tempo, representado como um gráfico de linhas, com o eixo x mostrando o intervalo de datas e o eixo y exibindo a contagem de solicitações. Uso por versão Distribuição de solicitação de API em diferentes versões nos últimos 10 dias. - Eventos
- Exibe os seguintes cartões.
Cartão Descrição Alertas críticos Alertas críticos gerados por operações de TI relacionadas à API que permitem identificar os principais problemas capazes de afetar o desempenho da API. Selecione o cartão para exibir todos os alertas em aberto no Espaço de operações de serviços e acessar informações mais detalhadas sobre eles. Para obter mais informações, consulte Service Operations Workspace.
incidentes Incidentes registrados, como indisponibilidades, solicitações de mudança ou problemas relacionados à API, considerados essenciais para rastrear a integridade operacional e os esforços de correção. Selecione o cartão para exibir todos os incidentes em aberto no Espaço de operações de serviços e acessar informações mais detalhadas sobre eles. Para obter mais informações, consulte Service Operations Workspace.
- Segurança
- Exibe os seguintes cartões.
Cartão Descrição Itens ativos de vulnerabilidade Vulnerabilidades de segurança associadas à API que permitem rastrear e eliminar riscos em potencial. Selecione o cartão para exibir todas as vulnerabilidades no Espaço para gerentes de vulnerabilidades e acessar informações mais detalhadas sobre eles. Para obter mais informações, consulte Vulnerability Manager Workspace.
Incidentes de segurança A opção Incidentes de segurança, se habilitada, fornece informações sobre violações ou problemas de segurança que podem ter ocorrido com a API. Selecione o cartão para exibir todos os incidentes de segurança em aberto no Espaço de resposta a incidentes de segurança e acessar informações mais detalhadas sobre eles. Para obter mais informações, consulte Security Incident Response Workspace.
- Mapa de relacionamento
- Fornece uma visão geral hierárquica dos relacionamentos da API com seus componentes, plataformas de gestão, aplicações de negócios e designs, facilitando a compreensão da função da API na arquitetura completa do sistema. Além disso, fornece a opção de gerenciar relacionamentos de serviço de aplicações. Consulte Como gerenciar relacionamentos de serviço de aplicações para APIs.
O mapa de relacionamento é um mapa parcial unificado e semelhante ao usado no Espaço do CMDB. Para abrir o mapa unificado de APIs, selecione Abrir mapa completo na seção "Mapa de relacionamento" da página de detalhes da API. Para saber mais, consulte Mapa unificado.
Figura 2. Mapa unificado para APIs - Os elementos a seguir estão disponíveis no mapa unificado para APIs:
- 1: Mapa
- O mapa exibe a API especificada e suas conexões e relacionamentos. No exemplo, o httpbin.org-v1.1 é o nó inicial, e as linhas representam conexões e relacionamentos com outros componentes. Selecione qualquer nó para exibir detalhes, como serviços de aplicações relacionados e histórico de mudanças.
- 2: Controles de conteúdo
-
- Pesquise e selecione o nó inicial, especifique o número de níveis de relacionamento para exibição dos serviços de aplicações e recarregue o mapa depois de fazer as mudanças.
- Use filtros para limitar os tipos e os tipos de relacionamento exibidos no mapa.
- Mostre ou oculte a linha do tempo dos eventos (itens relacionados) da API selecionada
- 3: Caixa de ferramentas
- Use a caixa de ferramentas para controlar diversos aspectos visuais do mapa, como nível de zoom ou modo de layout.
- 4: Painel lateral contextual
-
- O painel Atributos (
) lista atributos, como local e status operacional, referentes ao relacionamento ou à API selecionada. - O painel Serviços de aplicações (
) lista detalhes dos serviços de aplicações associados à API selecionada. - O painel Itens relacionados (
) mostra itens relacionados, como incidentes ativos ou problemas ativos, da API selecionada. - O painel Mudanças (
) lista as mudanças, como mudanças no status operacional, da API selecionada.
- O painel Atributos (
- 5: Navegador de minimapa
- Defina o nível de zoom ou mova a exibição para uma área de interesse. Selecione o ícone para mostrar ou ocultar o navegador.
- 6: Linha do tempo
- A linha do tempo indica eventos (itens relacionados) como incidentes, problemas e mudanças na API selecionada durante um período especificado. Você pode usar a linha do tempo para visualizar o histórico de mudanças em uma API e como essas mudanças afetam a topologia do CMDB.