Overview (Visão geral das APIs)

Ao clicar em um cartão (card) na tela API Catalog, você acessa a tela de Overview, onde pode visualizar um resumo completo da API, incluindo dados básicos, revisões, recursos, fluxos e estatísticas de uso.

Para realizar qualquer alteração nas configurações, abra a tela de edição por meio do botão Edit API, localizado no topo da tela. Somente ao acessar a tela de edição é possível modificar definições, ajustar recursos ou abrir o arquivo Swagger.

Para consultar instruções detalhadas sobre a edição de APIs, acesse a documentação específica em: Editando ou excluindo uma API.

Estrutura da tela

overview api

A tela de Overview organiza as informações da sua API na seguinte estrutura:

Abas de navegação:

Clique em qualquer aba para explorar detalhes específicos da API.

Informações gerais

api header

Na parte superior da tela Overview, você visualiza rapidamente as principais informações da API, como tipo, número da Revision, total de Apps vinculadas, data de criação e planos associados.

Ainda nessa área, há um atalho para o API Trace, que redireciona para a página onde são exibidas todas as requisições realizadas para a API selecionada.

Na tela Overview, o ícone Swagger aparece desabilitado. Para visualizar o arquivo, abra a API em modo de edição e clique no ícone ao lado do campo Revision.

API Definitions (definições básicas da API)

A aba API Definitions apresenta as informações gerais da API.

api definitions

A subseção Portal Settings aparece desabilitada nesta aba da tela Overview. Para acessá-la, abra a API em modo de edição.

Resources (recursos)

Em Resources, você pode visualizar todos os recursos e operações da API.

resources

Flows (fluxos)

Em Flows, você acompanha os interceptores inseridos em todos os pontos dos recursos e operações da API.

flows

Environments

Na aba Environments, você pode visualizar os ambientes nos quais sua API está implantada. Esses ambientes devem estar previamente registrados.

environment

Na tela de Overview, você acessa informações de tráfego e dados vinculados à API, como:

  • Status de cada environment.

  • Número de chamadas realizadas à API nos últimos 30 dias.

  • Número da Revision.

Há um botão de copy ao lado da URL. Utilize-o para copiar o endereço diretamente, dispensando a seleção manual.

Timeline

A aba Timeline mostra as mudanças feitas na API, com filtros por período e tipo de mudança.

Adaptive Governance

Se o Adaptive Governance estiver disponível na sua Plataforma, será exibido, à direita da tela, um painel com as funcionalidades Workflow stage, Attributes e Maturity Score.

Essas funcionalidades mostram o progresso da criação da API, indicando o estágio atual, os atributos configurados e o nível de maturidade alcançado, além de sugerir melhorias.

adaptive governance
Thanks for your feedback!
EDIT

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