Caricamento dei Risultati di Accessibilità JSON su 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

Uso del sottocomando bulk-reports per caricare i risultati su Axe Reports

Not for use with personal data

Puoi usare la CLI per inviare i risultati a Axe Reports con il sottocomando bulk-reports. Avrai bisogno di una chiave API, che è descritta in Ottenere una chiave API.

Per creare i file di risultati utilizzati da questo comando, consulta la sezione Generare i risultati qui di seguito.

note

Caricare i risultati con bulk-reports non popola le metriche di utilizzo nei rapporti Axe (i rapporti Utilizzo mensile e URL scansionati). Queste vengono popolate dal servizio di utilizzo. Vedere Visualizzazione dei dati di utilizzo nei rapporti Axe.

Comando bulk-reports

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

note

Axe Reports richiede che la directory dei rapporti contenga file di risultati JSON.

Esempio

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

Opzioni

Opzione	Descrizione
--send-axe-reports	Necessario per indicare che i risultati dei rapporti Axe devono essere caricati in blocco.
--axe-reports-api-key	La chiave API necessaria per caricare i rapporti sul servizio Axe Reports di Deque.
--axe-reports-url	(Opzionale) L'URL del server Axe Reports dove verranno caricati i risultati. Il valore predefinito è `https://axe-reports-server.dequecloud.com/`. Imposta questo solo se la tua organizzazione utilizza un server Axe Reports diverso.
--dimensioni-axe-reports	(Opzionale) Elenco di dimensioni JTBD (jobs-to-be-done) separato da virgole, utilizzato per categorizzare la scansione nei Rapporti Axe. Vedi Dimensioni JTBD.

Dimensioni JTBD

L'opzione --axe-reports-dimensions contrassegna i risultati caricati con una o più dimensioni JTBD (jobs-to-be-done) in modo da poter raggruppare e filtrare le scansioni nei Rapporti Axe. Le dimensioni sono etichette a forma libera che scegli tu, come il nome di un team, una versione o un'area applicativa; non esiste un insieme fisso di valori validi. Separare più dimensioni con virgole:

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

Le dimensioni sono registrate sul progetto nel payload caricato, non su pagine singole, quindi descrivono il caricamento nel suo insieme.

La stessa opzione è disponibile quando si testa una singola pagina (vedi --axe-reports-dimensions) e quando si esegue un file di specifica del flusso di lavoro.

Variabile d'ambiente

Variabile	Descrizione
`AXE_REPORTER_API_KEY`	La tua chiave API di Axe Reports. Per ulteriori informazioni su come ottenere una chiave API, vedi Ottenere una chiave API. Inserendo la tua chiave API in una variabile d'ambiente, puoi evitare di aggiungerla ai file salvati in un repository Git.

L'API key è l'unico valore che puoi impostare con una variabile d'ambiente. Per caricare su un server Axe Reports diverso da quello predefinito, utilizza l'opzione --axe-reports-url.

Ottenere una chiave API

Per ottenere una chiave API, contatta direttamente il tuo rappresentante Deque, raggiungici tramite il nostro servizio clienti, o inviaci un'email. Saremo felici di aiutarti.

Generare i risultati

Ci sono diversi modi per generare risultati per il caricamento su Axe Reports. Questa sezione contiene link a codice di esempio che mostra come generare risultati di accessibilità.

Per esempi in Node.js e JavaScript, vedi Esempi di codice per il pacchetto @axe-devtools/reporter