Subiendo Resultados de Accesibilidad JSON a Axe Reports

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Usando el subcomando bulk-reports para subir resultados a Axe Reports

Not for use with personal data

Puede usar la CLI para enviar resultados a Axe Reports con el subcomando bulk-reports. Necesitará una clave API, que se describe en Obteniendo una clave API.

Para crear los archivos de resultados que usa este comando, consulta la sección Generando resultados a continuación.

note

Cargar resultados con bulk-reports no completa las métricas de uso en los informes Axe (los informes Uso por mes y URLs escaneadas). En su lugar, estas se completan mediante el servicio de uso. Consulte Visualización de sus datos de uso en los informes Axe.

Comando bulk-reports

axe bulk-reports <results-dir> --send-axe-reports --axe-reports-api-key <api-key>

note

Axe Reports requiere que el directorio de informes contenga archivos de resultados JSON.

Ejemplo

axe bulk-reports ./results --axe-reports-api-key 720abdd2-03a3-41bf-b820-0cc38af67057 --send-axe-reports

Opciones

Opción	Descripción
--send-axe-reports	Es necesario indicar que los resultados de los informes Axe se deben cargar en masa.
--axe-reports-api-key	La clave API necesaria para cargar los informes al servicio Axe Reports de Deque.
--axe-reports-url	(Opcional) La URL del servidor de Axe Reports donde se subirán los resultados. Por defecto es `https://axe-reports-server.dequecloud.com/`. Establezca esto solo si su organización utiliza un servidor de Axe Reports diferente.
--axe-reports-dimensions	(Opcional) Lista de dimensiones JTBD (trabajos por hacer), separadas por comas, utilizadas para categorizar el escaneo en los informes de Axe. Ver Dimensiones JTBD.

Dimensiones JTBD

La opción --axe-reports-dimensions etiqueta los resultados cargados con una o más dimensiones JTBD (trabajos por hacer) para que puedas agrupar y filtrar escaneos en los informes de Axe. Las dimensiones son etiquetas de formato libre que eliges, como el nombre de un equipo, una versión o un área de aplicación; no hay un conjunto fijo de valores válidos. Separa múltiples dimensiones con comas:

axe bulk-reports ./results --send-axe-reports --axe-reports-api-key <your-API-key> --axe-reports-dimensions checkout,mobile-web

Las dimensiones se registran en el proyecto en la carga subida, no en páginas individuales, por lo que describen la carga en su totalidad.

La misma opción está disponible al probar una sola página (ver --axe-reports-dimensions) y al ejecutar un archivo spec de flujo de trabajo.

Variable de entorno

Variable	Descripción
`AXE_REPORTER_API_KEY`	Su clave API de Axe Reports. Para más información sobre cómo obtener una clave API, vea Obteniendo una clave API. Al poner su clave API en una variable de entorno, puede evitar agregarla a los archivos en un repositorio de Git.

La clave de API es el único valor que puede establecer con una variable de entorno. Para subir a un servidor de Axe Reports diferente al predeterminado, use la opción --axe-reports-url.

Obteniendo una clave API

Para obtener una clave API, contacta directamente a tu representante de Deque, comunícate con nosotros a través de nuestra mesa de ayuda, o envíanos un correo electrónico. Estaremos encantados de ayudarte.

Generando resultados

Existen varias formas de generar resultados para subir a Axe Reports. Esta sección contiene enlaces a código de ejemplo que muestra cómo generar resultados de accesibilidad.

Para ejemplos de Node.js y JavaScript, consulta Muestras de código para el paquete @axe-devtools/reporter