Detalles de un Elemento del Catálogo
Se puede acceder la pantalla de detalles de una API específica a través de la pantalla Discovery. Para ello, haga clic en el icono , en el listado de elementos del catálogo.
Aquí puede consultar información general de la API, así como sus revisiones y los entornos asociados.
La información se presenta en dos pestañas: GENERAL DATA y DETAILS.
Pestaña GENERAL DATA
Esta pestaña muestra, en la parte superior, un panel con información general sobre la API, en el que se puede consultar:
-
Name: nombre;
-
Version: versión más reciente;
-
Description: descripción.
-
API Responsible: usuario responsable;
-
Created At: fecha y hora de creación;
-
Imported At: fecha y hora de importación;
-
Updated At: fecha y hora de actualización;
-
Tags: tags asociados. Si aún no hay ninguna, y usted desea añadir tags, haga clic en el ícono para añadirlas y siga los pasos a continuación:
-
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 "-").
-
Haga clic en + (o pulse ENTER) para asociar el tag.
-
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.
-
Haga clic en OK para cerrar la ventana modal.
-
En la esquina superior derecha de la pantalla, se puede ver el score de madurez de su API (MATURITY), que se define automáticamente después de la importación.
Para ver el informe de madurez de la última revisión de la API y su especificación, haga clic en Latest Revision. |
Pestaña DETAILS
En esta pestaña, puede ver detalles de la API según el entorno de despliegue de la revisión.
Para ello, seleccione un modo de visualización haciendo clic en la flecha de la derecha del campo VIEW MODE.
Por defecto, el modo Environments ya está seleccionado. |
Hay dos formas de visualización disponibles:
- Environments
-
La tabla muestra las siguientes columnas:
-
DESCRIPTION: nombre del environment;
-
URL: host + basepath del environment;
-
DEPLOYED REVISION: número o fecha de la revisión actual en el environment;
-
Cuando no hay una revisión de la API desplegada en un environment listado, se mostrará un guión ("-") y la madurez tendrá el score establecido en cero. |
-
MATURITY: score de madurez;
-
ACTIONS: acceso al Informe de Madurez y Especificación de API.
- Revisions
-
-
DESCRIPTION: descripción;
-
DEPLOYED IN ENVIRONMENT: entorno donde la revisión está desplegada;
-
MATURITY: score de madurez;
-
ACTIONS: acceso al Informe de Madurez y Especificación de API.
-
Share your suggestions with us!
Click here and then [+ Submit idea]