JSON-toegankelijkheidsresultaten uploaden naar 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

De subopdracht bulk-reports gebruiken om resultaten naar Axe Reports te uploaden

Not for use with personal data

Je kunt de CLI gebruiken om resultaten naar Axe Reports te sturen met de subopdracht bulk-reports. Je hebt een API-sleutel nodig, die wordt beschreven in Een API-sleutel verkrijgen.

Om de resultatenbestanden te maken die deze opdracht gebruikt, zie de sectie Resultaten genereren hieronder.

note

Het uploaden van resultaten met bulk-reports vult de gebruiksstatistieken in Axe-rapporten (de Gebruik per maand en Gescreende URL's rapporten) niet in. Deze worden in plaats daarvan door de gebruiksdienst gevuld. Zie Uw gebruiksgegevens bekijken in Axe-rapporten.

bulk-reports-opdracht

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

note

Axe Reports vereist dat de rapportmap JSON-resultaatbestanden bevat.

Voorbeeld

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

Opties

Optie	Beschrijving
--send-axe-reports	Noodzakelijk om aan te geven dat de resultaten van Axe-rapporten in bulk moeten worden geüpload.
--axe-reports-api-key	De API-sleutel die nodig is om de rapporten naar de Axe Reports-service van Deque te uploaden.
--axe-reports-url	(Optioneel) Geeft de URL van de server aan waar de rapporten zullen worden geüpload.
--bijl-rapport-dimensies	(Optioneel) Kommagescheiden lijst van JTBD (jobs-to-be-done) dimensies die worden gebruikt om de scan in Axe-rapporten te categoriseren. Zie JTBD Dimensies.

JTBD Dimensies

De --axe-reports-dimensions-optie tagt de geüploade resultaten met een of meer JTBD (jobs-to-be-done) dimensies zodat je scans kunt groeperen en filteren in Axe-rapporten. Dimensies zijn vrij te kiezen labels, zoals een teamnaam, een release of een toepassingsgebied; er is geen vaste set van geldige waarden. Scheid meerdere dimensies met komma's:

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

De dimensies worden vastgelegd op het project in de geüploade payload, niet op individuele pagina's, dus ze beschrijven de upload als geheel.

Dezelfde optie is beschikbaar bij het testen van een enkele pagina (zie --axe-reports-dimensions) en bij het uitvoeren van een workflow-specbestand.

Omgevingsvariabelen

Variabele	Beschrijving
`AXE_REPORTER_API_KEY`	Je Axe Reports API-sleutel. Voor meer informatie over het verkrijgen van een API-sleutel, zie Een API-sleutel verkrijgen. Door je API-sleutel in een omgevingsvariabele te plaatsen, kun je voorkomen dat deze in ingediende bestanden in een Git-repository terechtkomt.
`AXE_REPORTS_URL`	(Optioneel) Specificeert de URL waar de resultaten worden geüpload. Dit is meestal het adres van de Axe Reports-server.

Een API-sleutel verkrijgen

Om een API-sleutel te verkrijgen, neem direct contact op met je Deque-vertegenwoordiger, bereik ons via onze helpdesk, of stuur ons een e-mail. We helpen je graag.

Resultaten genereren

Er zijn verschillende manieren om resultaten te genereren voor upload naar Axe Reports. Deze sectie bevat links naar voorbeeldcode die laat zien hoe toegankelijkheidsresultaten kunnen worden gegenereerd.

Voor Node.js- en JavaScript-voorbeelden, zie Codevoorbeelden voor het @axe-devtools/reporter-pakket