Overview (visión general)

Al hacer clic en una tarjeta (card) en la pantalla API Catalog, se accede a la pantalla de Overview, donde es posible visualizar un resumen completo de la API, incluyendo datos básicos, revisiones, recursos, flujos y estadísticas de uso.

Para realizar cualquier cambio en la configuración, abra la pantalla de edición mediante el botón Edit API, ubicado en la parte superior de la pantalla. Solo al acceder a la pantalla de edición es posible modificar definiciones, ajustar recursos o abrir el archivo Swagger.

Para consultar instrucciones detalladas sobre la edición de APIs, acceda a la documentación específica en: Editando o eliminando una API.

Estructura de la pantalla

overview api

La pantalla de Overview organiza la información de su API en las siguientes secciones:

Pestañas de navegación:

Haga clic en cualquier pestaña para explorar los detalles específicos de la API.

Información general

api header

En la parte superior de la pantalla Overview, se visualiza rápidamente la información principal de la API, como el tipo, el número de la Revision, el total de Apps vinculadas, la fecha de creación y los planes asociados.

En esta misma área, hay un acceso directo a API Trace, que redirige a la página donde se muestran todas las solicitudes realizadas para la API seleccionada.

En la pantalla Overview, el ícono de Swagger aparece deshabilitado. Para visualizar el archivo, abra la API en modo de edición y haga clic en el ícono junto al campo Revision.

API Definitions (definiciones básicas de la API)

En API Definitions, puede consultar la información general de la API.

api definitions

La subsección Portal Settings aparece deshabilitada en esta pestaña de la pantalla Overview. Para acceder a ella, abra la API en modo de edición.

Resources (recursos)

En Resources and Operations, es posible visualizar todos los recursos y operaciones de la API.

resources

Flows (flujos)

En Flows, se pueden consultar los interceptores insertados en todos los puntos de los recursos y operaciones de la API.

flows

Environments

En la pestaña Environments, se pueden visualizar los entornos en los cuales la API está implementada. Estos entornos deben estar previamente registrados.

environment

En la pantalla de Overview, puede acceder a información de tráfico y datos vinculados a la API, como:

  • Estado de cada environment.

  • Número de llamadas realizadas a la API en los últimos 30 días.

  • Número de la Revision.

Hay un botón de copy junto a la URL. Úselo para copiar la dirección directamente, sin necesidad de seleccionar el texto manualmente.

Timeline

La pestaña Timeline muestra los cambios realizados en la API, con filtros por período y tipo de cambio.

Adaptive Governance

Si Adaptive Governance está disponible en su Plataforma, se mostrará, a la derecha de la pantalla, un panel con las funcionalidades Workflow stage, Attributes y Maturity Score.

Estas funcionalidades muestran el progreso de la creación de la API, indicando la etapa actual, los atributos configurados y el nivel de madurez alcanzado, además de sugerir mejoras.

adaptive governance
Thanks for your feedback!
EDIT

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