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
. -
Haga clic en la pestaña DOCUMENTATION.
-
Verá el informe de madurez y especificación de la revisión más reciente. Haga clic en el número de la revisión para la cual desea ver el informe de madurez y especificación.
-
Alternativamente, haga clic en la pestaña DEPLOYMENTS para ver las revisiones implementadas en cada entorno. Haga clic en el número de la revisión para la cual desea ver el informe de madurez y especificación.
-
|
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: SPECIFICATION y PREVIEW.
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
Pestaña SPECIFICATION
En esta pestaña encontrará una lista con las violaciones que componen el score.
| La lista de violaciones está disponible solo para APIs del tipo REST. |
Las violaciones están divididas por niveles, presentadas en pestañas:
-
HIGH VIOLATION: violaciones graves que impactan significativamente en el score de madurez de la API.
-
MEDIUM VIOLATION: violaciones de impacto medio.
-
LOW VIOLATION: violaciones de bajo impacto.
Cada pestaña lista las violaciones encontradas en ese nivel de gravedad, en una lista con las columnas:
-
LINE: número de línea en la especificación de la API donde se encontró la violación.
-
VIOLATION: descripción de la violación encontrada.
-
Columna con acciones posibles para cada violación:
-
: ver la regla que fue violada:
-
RULE ID: código de la regla.
-
DESCRIPTION: descripción de la regla, con información sobre su objetivo y base. Contiene los campos
contextyfield. -
WEIGHT ON SCORE: porcentaje que el campo representa en el score total de madurez.
-
-
Visualizando la especificación de la API
Acceda a la pestaña PREVIEW para visualizar la especificación de la API (Swagger), con sus respectivos endpoints.
Share your suggestions with us!
Click here and then [+ Submit idea]