Las guías de estilos son el conjunto de reglas que se aplican al escaneo de las APIs.
Por defecto se crea una guía de estilos con el nombre de la organización que se usa de forma predeterminada en todas las colecciones que creemos y que no tengan vinculada una guía de estilos concreta. Aunque se pueden añadir todas las guías que se deseen a tu organización. Todas las guías de estilos tendrán por defecto activadas todas las reglas.
Para crear más guías de estilos, se debe acceder a dicha pantalla desde el menú de configuración y hacer clic en el botón Crear Guía de Estilos.
Dentro del diálogo de creación, se nos pedirá introducir un nombre para la guía de estilos y marcar si queremos que esta nueva guía sea utilizada por defecto en caso de no vincular ninguna a las colecciones de APIs.
Si todo ha ido bien, visualizamos el siguiente aviso:
Si necesitamos realizar cambios en una guía de estilos, podemos modificarla haciendo clic en el icono del lápiz o eliminarla haciendo clic en el icono de la papelera:
Reglas de una guía de estilos #
Las reglas de las guías de estilos analizan las definiciones de APIs, asegurando que sigan estándares específicos y buenas prácticas, garantizando su correcta funcionalidad y coherencia.
Podemos visualizar las reglas que pertenecen a una guía de estilos concreta haciendo clic en su nombre.
Desde esta pantalla, podemos configurar las reglas que se usarán para escanear una API con la guía de estilos seleccionada, modificar los valores de los parámetros en aquellas reglas que así lo permitan, etc.
Podemos activar y desactivar tantas reglas como queramos, teniendo en cuenta que solo podrán editarse aquellas que se encuentren activas.
Dentro del diálogo de edición, podremos modificar la severidad de la regla, así como los parámetros que tenga asociados. Una vez realizados los cambios necesarios, pulsamos en Editar regla para guardar.