Carregando Resultados de Acessibilidade JSON para 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 o subcomando bulk-reports para carregar resultados no Axe Reports

Not for use with personal data

Você pode usar o CLI para enviar resultados ao Axe Reports com o subcomando bulk-reports. Você precisará de uma chave de API, que é descrita em Obtendo uma Chave de API.

Para criar os arquivos de resultados que este comando usa, veja a seção Gerando Resultados abaixo.

note

Carregar resultados com bulk-reports não preenche as métricas de uso nos Relatórios Axe (os relatórios Uso por Mês e URLs Verificadas). Esses são preenchidos pelo serviço de uso. Veja Visualizando Seus Dados de Uso em Relatórios Axe.

Comando bulk-reports

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

note

O Axe Reports exige que o diretório de relatórios contenha arquivos de resultados JSON.

Exemplo

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

Opções

Opção	Descrição
--send-axe-reports	Necessário indicar que os resultados dos Relatórios Axe devem ser carregados em massa.
--axe-reports-api-key	A chave de API necessária para carregar os relatórios para o serviço Axe Reports da Deque.
--axe-reports-url	(Opcional) Indica a URL do servidor onde os relatórios serão carregados.
--axe-reports-dimensions	(Opcional) Lista de dimensões JTBD (jobs-to-be-done) separadas por vírgulas usadas para categorizar a varredura nos Relatórios Axe. Veja Dimensões JTBD.

Dimensões JTBD

A opção --axe-reports-dimensions etiqueta os resultados enviados com uma ou mais dimensões JTBD (jobs-to-be-done) para que você possa agrupar e filtrar varreduras nos Relatórios Axe. Dimensões são rótulos de forma livre que você escolhe, como o nome de uma equipe, uma versão ou uma área de aplicação; não há um conjunto fixo de valores válidos. Separe múltiplas dimensões com vírgulas:

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

As dimensões são registradas no projeto na carga enviada, não em páginas individuais, de modo que descrevem a carga como um todo.

A mesma opção está disponível ao testar uma única página (veja --axe-reports-dimensions) e ao executar um arquivo de especificação de fluxo de trabalho.

Variáveis de Ambiente

Variável	Descrição
`AXE_REPORTER_API_KEY`	Sua chave de API do Axe Reports. Para mais informações sobre como obter uma chave de API, veja Obtendo uma Chave de API. Colocando sua chave de API em uma variável de ambiente, você pode evitar adicioná-la a arquivos registrados em um repositório Git.
`AXE_REPORTS_URL`	(Opcional) Especifica o URL para onde os resultados serão carregados. Geralmente é o endereço do servidor Axe Reports.

Obtendo uma Chave de API

Para obter uma chave de API, entre em contato diretamente com seu representante Deque, entre em contato conosco através da nossa mesa de apoio, ou envie-nos um e-mail. Ficaremos felizes em ajudar.

Gerando Resultados

Existem várias maneiras de gerar resultados para upload no Axe Reports. Esta seção contém links para códigos de exemplo mostrando como gerar resultados de acessibilidade.

Para exemplos em Node.js e JavaScript, veja Exemplos de Código para o Pacote @axe-devtools/reporter