Carregando Resultados de Acessibilidade JSON para o axe Reports
Usando o subcomando bulk-reports para carregar resultados no axe Reports
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.
Comando bulk-reports
axe bulk-reports <results-dir> --send-axe-reports --axe-reports-api-key <api-key>O axe Reports requer 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-reportsOpções
| Opção | Descrição |
|---|---|
| --send-axe-reports | Necessário para indicar que os relatórios do 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. |
Variáveis de Ambiente
| Variável | Descrição |
|---|---|
| AXE_REPORTER_API_KEY | Sua chave de API para o axe Reports. Para mais informações sobre como obter uma chave de API, veja Obtendo uma Chave de API. Ao colocar sua chave de API em uma variável de ambiente, você pode evitar adicioná-la a arquivos versionados em um repositório Git. |
| AXE_REPORTS_URL | (Opcional) Especifica o URL 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
Há várias maneiras de gerar resultados para carregamento no axe Reports. Esta seção contém links para códigos de exemplo que mostram como gerar resultados de acessibilidade.
Para exemplos em Node.js e JavaScript, veja Exemplos de Código para o Pacote @axe-devtools/reporter
Para outras linguagens, veja:
- Para C#, veja Gerar Relatórios com C#.
- Para Java, veja Gerar Relatórios com Java.
- Para Python, veja Gerar Relatórios com Python.
