Thanks for your feedback!
EDIT
Informe de Madurez, especificación de API y Smart Recommendations
En esta pantalla (vea cómo acceder a ella) puede:
-
analizar la calidad de la API y ver las reglas que viola, cuando sea necesario;
-
visualizar la especificación de la API (Swagger);
Haga clic en los enlaces anteriores para obtener detalles de cada funcionalidad o vea el video a continuación para una visión general:
Cómo acceder a la pantalla
Para acceder a la pantalla que muestra el informe de madurez, especificación y Smart Recommendations, siga los siguientes pasos:
-
Acceda a la pantalla Discovery, haciendo clic en el menú lateral izquierdo.
-
Localice la API que desea analizar y haga clic en el icono
. -
En la pestaña GENERAL DATA, en la esquina superior derecha de la pantalla, haga clic en Latest Revision.
-
En este caso, verá el informe de madurez y especificación de la revisión más reciente.
-
Alternativamente, justo debajo, en la pestaña DETAILS, haga clic en el icono
en la fila correspondiente a la revisión.
El icono aparece en ambos modos de visualización (Environments o Revisions).
-
|
En el modo Environments, el icono estará desactivado cuando no haya una revisión de la API implementada en el entorno.
|
La información se presenta en dos pestañas: QUALITY ANALYSIS y SPECIFICATION.
Score de madurez
El score de madurez se calcula en base a un conjunto de criterios o reglas (Rules) que evalúan el grado de madurez de la API.
El cálculo sigue una fórmula que asigna pesos a cada regla, aplicando penalizaciones a la puntuación cuando no se cumplen los criterios establecidos por las reglas.
El resultado se muestra en una escala porcentual, junto con un concepto que clasifica el grado de conformidad de la API con las reglas establecidas.
Estas reglas, junto con sus descripciones y pesos en relación al cálculo de la puntuación, se muestran en la pestaña QUALITY ANALYSIS.
Junto al score, encontrará:
-
la revisión de la API para la cual se generó el informe,
-
los entornos en los que se implementa la API, y
-
el botón para acceder a ejemplos de aplicación de las recomendaciones, disponibles para su descarga, basados en Inteligencia Artificial (Smart Recommendations).
Analizando la calidad de sus APIs
Para comprender la puntuación de su API, haga clic en la pestaña QUALITY ANALYSIS.
En esta pestaña encontrará una lista con las reglas que componen la puntuación.
Consulte la descripción de cada regla, el peso que tiene en el cálculo de la puntuación y las violaciones encontradas.
Cada regla se muestra en una fila de la tabla que contiene las siguientes columnas:
-
RULE ID: código de la regla.
-
DESCRIPTION: descripción de la regla, con información sobre su objetivo y fundamentos. Contiene los campos
contextyfield.-
WEIGHT ON SCORE: porcentaje que el campo representa en la puntuación total de madurez;
-
SEVERITY OF VIOLATIONS: grado de gravedad de la violación encontrada (None para ninguna, Low para baja, Media_ o High para alta) y el porcentaje penalizado.
-
VIOLATIONS: al hacer clic en
, se muestra un modal con la lista de reglas violadas. El ícono estará desactivado cuando no haya violaciones.
Para cada recomendación, un ícono de color indica su grado de gravedad.
-
|
Para ver solo las reglas violadas, habilite el botón de alternancia View only violated rules. |
Visualizar el swagger
Acceda a la pestaña SPECIFICATION para ver la especificación de la API (Swagger), con sus respectivos endpoints.
ujnm
Share your suggestions with us!
Click here and then [+ Submit idea]