Discovery

En Discovery tiene una visión general de la información principal de sus APIs.
Este catálogo de APIs admite múltiples gateways, lo que permite un mayor control y organización de su ecosistema.

Enlaces rápidos

Vea cómo:

Realizar una búsqueda
Agregar una tag a una API
Eliminar una tag de una API
Aplicar una edición en varias APIs
Ver el nivel de madurez de la API
Obtener Smart Recommendations (descargar los contratos con las modificaciones recomendadas aplicadas)
Verificar si existen API redundantes.

Totalizadores

En la parte superior de la pantalla Discovery, encontrará un dashboard con métricas de su catálogo, según los filtros aplicados.

Number of APIs: muestra el número total de APIs en el catálogo.
Haga clic en la tarjeta para ver una representación gráfica con el total de APIs categorizadas por proveedor.
Uncategorized APIs: total de APIs que no tienen una tag asociada.
APIs recently imported: total de APIs importadas al catálogo en los últimos 7 días. Vea cómo cambiar el período.
APIs recently updated: total de APIs en el catálogo actualizadas en los últimos 7 días. Vea cómo cambiar el período:
Para cambiar el período de APIs recently imported o APIs recently updated:
1. Haga clic en el icono de la tarjeta.
2. Seleccione el período deseado:
  
  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 OK.

Listado de APIs

Las APIs importadas se muestran en una tabla con las siguientes columnas:

catálogo de APIs

PROVIDER: icono que identifica el proveedor del gateway (ejemplos: Sensedia, AWS, entre otros).
NAME: nombre de la API.
VERSION: versión actual.
OWNER: haga clic en y seleccione una de las opciones:
- View owner: para ver quién es el responsable de las APIs, ya sea un equipo o un usuario.
- View shared with: para ver con quién están compartidas las APIs.
MATURITY: score de madurez de la API, que puede ser:

Ícono Nivel Rango

Básico

0 a 29%

Intermedio

30 a 79%

Avanzado

80 a 94%

Excelente

95 a 100%

Obtenga el informe de madurez completo y recomendaciones generadas por inteligencia artificial, con la opción de descargar el Swagger con las recomendaciones aplicadas.

Ícono	Nivel	Rango
	Básico	0 a 29%
	Intermedio	30 a 79%
	Avanzado	80 a 94%
	Excelente	95 a 100%

ISSUES: indica la existencia de problemas que pueden afectar la calidad de las APIs y su ecosistema. Identifica elementos que pueden modificarse para mejorar aspectos como la organización y el rendimiento.
Tipos de Issues más comunes:

Consistency: relacionado con la consistencia y organización de las APIs. Indica la existencia de violaciones de buenas prácticas en contratos OpenAPI. Verifica si los contratos están completos y consistentes, asegurando que el desarrollo y la documentación estén alineados con las reglas de la organización.

Efficiency: relacionado con el uso de los recursos. Indica la presencia de redundancias y oportunidades de optimización. No abarca aspectos relacionados con el rendimiento.

Un campo vacío en la columna ISSUES inmediatamente después de la importación no indica necesariamente la ausencia de problemas.
Después de la importación, las APIs deben procesarse, y el tiempo para la generación de las Issues puede variar de minutos a varias horas, dependiendo de la cantidad de APIs y del tamaño de los contratos importados.

TAGS: etiquetas. Vea cómo funcionan las tags.
ACTIONS:
- : ver detalles sobre el elemento correspondiente, como los datos generales, revisiones y entornos asociados;
- : agregar tags al elemento correspondiente o gestionar las ya existentes.

Búsqueda de APIs

Para ver todas las opciones de filtrado, haga clic en el icono .

Puede buscar las APIs por:

Name: nombre de la API.
Tags: tags (etiquetas). Seleccione o escriba el nombre de la tag. Vea cómo funcionan las tags.
Utilice el campo Tag Mode para definir el criterio de búsqueda de las tags:
- Any of selected: APIs que tienen al menos una de las tags seleccionadas en el campo Tags (predeterminado);
- All of selected: APIs que tienen todas las tags seleccionadas en el campo Tags;
- None of selected: APIs que no tienen las tags seleccionadas en el campo Tags;
- No tag applied: muestra las APIs que no tienen tags.
Version: versión de la API.
Description: contenido del campo de descripción de la API.
Provider: proveedor del gateway (ejemplos: Sensedia, AWS, entre otros).
Connections: nombre de la conexión.
Owners: responsable (equipo o usuario) de la API.
Shared with: equipo o usuario con quien la API está compartida. Puede utilizar uno o más equipos o usuarios para realizar la búsqueda.
Imported At: día de importación de la API.
Updated At: día de la última actualización de la API.

Después de ingresar los valores en los campos deseados, haga clic en SEARCH para realizar la búsqueda, o en CLEAR para limpiar los campos completados.

Categorización por tags

La categorización por tags permite clasificar y agrupar las APIs del catálogo mediante etiquetas personalizables, lo que facilita y agiliza la gestión de sus APIs. Esta funcionalidad permite buscar APIs de una misma categoría utilizando sus tags.

Asociar una tag a una API

Existen dos formas de asociar una tag a una API del catálogo:

Icono de tags
1. En el listado de APIs de la pantalla Discovery, haga clic en el icono de la API que desea categorizar (asociar una tag).
2. Si la API seleccionada aún no tiene una tag asociada, haga clic en ADD.
3. En el campo Tag Name, escriba el nombre de la tag que desea asociar (nueva o ya registrada previamente).
  El nombre de una tag debe contener entre 2 y 30 caracteres.
  
  Solo se aceptan caracteres alfanuméricos en minúscula y "-".
  
  El nombre de la tag no puede comenzar ni terminar con "-".
4. Haga clic en + (o presione ENTER en su teclado) para asociar la tag.
  
  Si hace clic en OK sin hacer clic en + (o presionar enter), la etiqueta no será asociada/creada.
5. Si desea agregar otra etiqueta, repita los dos últimos pasos. Cada API puede contener hasta 50 etiquetas asociadas.
6. Haga clic en OK para cerrar la ventana.
Ícono para ver detalles
1. En la lista de APIs de la pantalla Discovery, haga clic en el ícono de la columna ACTIONS de la API que desea categorizar (asociar la etiqueta).
2. Haga clic en el ícono ubicado al lado de Tags, en el panel BASIC INFO.
3. Siga los pasos 3 a 6 descritos arriba.

Eliminar etiquetas de una API

Existen dos formas de desvincular una o más etiquetas de una API del catálogo:

Ícono de etiquetas
1. En la lista de APIs de la pantalla Discovery, haga clic en el botón correspondiente a la API de la que desea desvincular la(s) etiqueta(s).
2. En la ventana que se abre, localice la etiqueta que desea desvincular de la API.
3. Haga clic en el botón X de esa etiqueta para eliminarla.
4. Si desea eliminar otra etiqueta de esta API, repita los dos últimos pasos.
5. Haga clic en OK para cerrar la ventana.

También puede desvincular etiquetas desde la pantalla de detalles de la API deseada:

En la pantalla de detalles de la API deseada, haga clic en el botón ubicado en el campo Tags del panel BASIC INFO.
Siga los pasos 2 a 5 descritos arriba.

Editando información de la API

Para editar la información de una API, haga clic en el ícono imagen de una lupa sobre una hoja de papel .

En el panel BASIC INFO, puede editar:

Owner: para editar quién es el responsable (usuario o equipo) de la API, haga clic en Owner y seleccione la opción deseada.
Shared with: para editar con quién se comparte la API, haga clic en Shared with y seleccione uno o más usuarios.

Edición masiva

Utilice la función de BULK EDIT (edición masiva) para registrar la misma información para varias APIs con una sola acción.

Para ello, siga estos pasos:

En la lista de APIs de la pantalla Discovery, seleccione las APIs que serán editadas.
Para seleccionar todas, haga clic en la casilla de selección al lado de PROVIDER, en la fila que muestra los títulos de las columnas.
Haga clic en el botón BULK EDIT.
Puede editar el Owner (responsable de la API) y Shared with (con quién se comparte la API).

Thanks for your feedback!

EDIT

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