Discovery

La pantalla Discovery incluye un catálogo con soporte para múltiples gateways que le permite centralizar sus APIs, haciendo que su ecosistema esté más organizado y aumentando su control sobre él.

discovery screen
Pantalla Discovery

Totalizadores

En la parte superior de la pantalla Discovery, encontrará un pequeño dashboard que trae métricas generales de su catálogo:

discovery totalizers

Los totalizadores muestran las métricas según los filtros aplicados a la pantalla. Son los siguientes:

  • Number of APIs: muestra el número total de APIs del catálogo. Pulsando sobre la ficha, se puede ver el número total de APIs por vendor.

  • Uncategorized APIs: número total de APIs que no tienen tag asociado.

  • APIs recently imported: número total de APIs importadas al catálogo en un periodo de tiempo determinado (en los últimos 7 días, por defecto). Puede cambiar el periodo de tiempo considerado:

    1. Haga clic en el botón icon settings de la tarjeta;

    2. En la ventana modal que se abre, seleccione el periodo deseado entre los siguientes:

      • Yesterday: día anterior;

      • Last 7 days: últimos 7 días;

      • Last 15 days: últimos 15 días;

      • Last 31 days: últimos 31 días.

    3. Haga clic en el botón OK.

  • APIs recently updated: número total de APIs del catálogo actualizadas en un periodo de tiempo determinado (en los últimos 7 días, por defecto). Puede cambiar el periodo de tiempo considerado:

    1. Haga clic en el botón icon settings de la tarjeta;

    2. En la ventana modal que se abre, seleccione el periodo deseado entre los siguientes:

      • Yesterday: día anterior;

      • Last 7 days: últimos 7 días;

      • Last 15 days: últimos 15 días;

      • Last 31 days: últimos 31 días.

    3. Pulse el botón OK.

Listado de APIs

Las APIs importadas se enumeran en una tabla, en la que cada fila corresponde a un elemento.

Para cada elemento, se muestra la siguiente información (columnas):

  • TYPE: tipo, representado por un icono;

  • NAME: nombre;

  • VENDOR: organización que lo gestiona;

  • CURRENT VERSION: última versión;

  • MATURITY: score de madurez de la API según la clasificación a continuación:

    • Básico: 0 a 29%

    • Intermediário: 30 a 79%

    • Avanzado: 80 a 94%

    • Excelente: 95 a 100%

Si el informe de madurez presenta datos de riesgo, verá un ícono de alerta junto al score. Al pasar el cursor sobre el icono, se mostrará un mensaje sobre el riesgo.

  • TAGS: tags asociados.

Es posible ordenar el listado (en orden ascendente o descendente) por nombre de API haciendo clic en el texto de cabecera de la columna NAME.

La columna ACTIONS contiene los siguientes botones:

icon visualize: permite ver detalles sobre el elemento correspondiente, como los datos generales, los endpoints y los entornos asociados;

icon tags: permite asociar tags al elemento correspondiente, así como gestionar los ya asociados.

Filtrar el listado

Para filtrar el listado, consulte las opciones encima de la tabla de elementos del catálogo.

Para ampliar los campos de filtro, haga clic en el icono icon expand. Encontrará estos campos de filtro:

  • Name: permite filtrar por el nombre del elemento.

  • Tag Mode: selecciona los criterios que se utilizarán al filtrar por tags:

    • Any of selected: muestra las APIs que tienen asociados al menos uno de los tags seleccionados en el campo Tags (por defecto);

    • All of selected: muestra las APIs que tienen asociados todos los tags seleccionados en el campo Tags;

    • None of selected: muestra las APIs que no tienen ninguno de los tags seleccionados en el campo Tags;

    • No tag applied: muestra las APIs que no tienen tags asociados.

  • Tags: permite filtrar las APIs por los tags asociados a ellas, según los criterios seleccionados en el campo Tag Mode.

  • Vendor: filtra por organización gestora.

  • Imported At: filtra por el día de importación de la API.

  • Updated At: filtra por el día de actualización de la API.

  • Version: filtra por la última versión.

  • Description: permite filtrar teniendo en cuenta la descripción del elemento.

Después de introducir los valores de los campos deseados, haga clic en SEARCH para realizar el filtrado, o en CLEAR para borrar los campos rellenados.

Categorización por tags

La categorización por tags le permite clasificar y agrupar las APIs de su catálogo mediante etiquetas personalizables, facilitando y agilizando la gestión de sus APIs. Esta funcionalidad le permite buscar APIs en la misma categoría utilizando sus tags.

Asociar un tag a una API

Para asociar un tag a una API del catálogo, siga estos pasos:

  1. En la lista de APIs de la pantalla Discovery, haga clic en el botón icon tags correspondiente a la API a la que desea asociar el tag.

  2. Si la API seleccionada aún no tiene un tag asociado, se abrirá una ventana modal con un mensaje. En esta ventana, haga clic en ADD.

  3. En el campo Tag Name, introduzca el nombre del tag que desea asociar (nuevo o registrado previamente). El nombre del tag debe contener un mínimo de 2 y un máximo de 30 caracteres. Sólo se aceptan caracteres alfanuméricos en minúsculas y "-" (sin embargo, el nombre no puede empezar ni terminar con "-").

  4. Haga clic en + (o pulse ENTER) para asociar el tag.

  5. Si desea añadir otro tag, repita los dos últimos pasos. Cada API puede contener hasta 50 tags asociados y el nombre de cada tag debe ser único.

  6. Haga clic en OK para cerrar la ventana modal.

Si la API ya tiene uno o varios tags asociados, también puede asociarle nuevos tags a través de la pantalla de detalles:

  1. En la lista de APIs de la pantalla Discovery, haga clic en el botón icon visualize correspondiente a la API a la que desea asociar el tag.

  2. Haga clic en el botón icon pencil situado en el campo Tags del panel GENERAL DATA.

  3. Siga los pasos 3 a 6 descritos anteriormente.

Eliminar tags de una API

Para desasociar uno o varios tags de una API del catálogo, siga estos pasos:

  1. En la lista de APIs de la pantalla Discovery, haga clic en el botón icon tags correspondiente a la API de la que desea desasociar el/los tag(s).

  2. En la ventana modal que se abre, localice el tag que desea desvincular de la API.

  3. Haga clic en el botón X correspondiente a ese tag para eliminarlo.

  4. Si desea eliminar otro tag de esta API, repita los dos últimos pasos.

  5. Haga clic en OK para cerrar la ventana modal.

También puede desasociar tags en la pantalla de detalles de la API deseada:

  1. En la pantalla de detalles de la API deseada, haga clic en el botón icon pencil situado en el campo Tags del panel GENERAL DATA.

  2. Siga los pasos 2 a 5 descritos anteriormente.

Thanks for your feedback!
EDIT

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