Hochladen von JSON-Zugänglichkeitsergebnissen zu 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

Verwendung des Unterbefehls bulk-reports zum Hochladen von Ergebnissen zu Axe Reports

Not for use with personal data

Sie können die CLI verwenden, um mit dem Unterbefehl bulk-reports Ergebnisse zu Axe Reports zu senden. Sie benötigen einen API-Schlüssel, der in Abrufen eines API-Schlüssels beschrieben wird.

Um die Ergebnissdateien zu erstellen, die dieser Befehl verwendet, siehe den Abschnitt Ergebnisse erzeugen unten.

note

Das Hochladen von Ergebnissen mit bulk-reports füllt die Nutzungskennzahlen in den Axe-Berichten (den Berichten Nutzung nach Monat und Gescannte URLs) nicht aus. Diese werden stattdessen vom Nutzungsdienst ausgefüllt. Siehe Verwendung Ihrer Nutzungsdaten in Axe-Berichten anzeigen.

bulk-reports-Befehl

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

note

Axe Reports verlangt, dass das Berichtsverzeichnis JSON-Ergebnisdateien enthält.

Beispiel

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

Optionen

Option	Beschreibung
--send-axe-reports	Erforderlich, um anzugeben, dass die Axe-Berichtergebnisse in großen Mengen hochgeladen werden sollen.
--axe-reports-api-key	Der benötigte API-Schlüssel, um die Berichte auf den Axe Reports-Dienst von Deque hochzuladen.
--axe-reports-url	(Optional) Die URL des Axe Reports-Servers, auf dem die Ergebnisse hochgeladen werden. Standardmäßig `https://axe-reports-server.dequecloud.com/`. Legen Sie dies nur fest, wenn Ihre Organisation einen anderen Axe Reports-Server verwendet.
--axe-reports-dimensionen	(Optional) Kommagetrennte Liste von JTBD-Dimensionen (Jobs-to-be-Done), die zur Kategorisierung des Scans in Axe Reports verwendet werden. Siehe JTBD-Dimensionen.

JTBD-Dimensionen

Die --axe-reports-dimensions-Option markiert die hochgeladenen Ergebnisse mit einer oder mehreren JTBD-Dimensionen (Jobs-to-be-Done), sodass Sie Scans in Axe Reports gruppieren und filtern können. Dimensionen sind freie Labels, die Sie wählen, wie z. B. ein Teamname, eine Veröffentlichung oder ein Anwendungsbereich; es gibt keine feste Menge von gültigen Werten. Trennen Sie mehrere Dimensionen durch Kommas:

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

Die Dimensionen werden im Projekt des hochgeladenen Inhalts und nicht auf den einzelnen Seiten gespeichert, daher beschreiben sie den Upload als Ganzes.

Die gleiche Option ist verfügbar, wenn eine einzelne Seite getestet wird (siehe --axe-reports-dimensions) und wenn eine Workflow-Spezifikationsdatei ausgeführt wird.

Umgebungsvariable

Variable	Beschreibung
`AXE_REPORTER_API_KEY`	Ihr Axe Reports API-Schlüssel. Für weitere Informationen zum Erhalt eines API-Schlüssels siehe Abrufen eines API-Schlüssels. Indem Sie Ihren API-Schlüssel in einer Umgebungsvariable speichern, können Sie vermeiden, ihn in Dateien in einem Git-Repository einzufügen.

Der API-Schlüssel ist der einzige Wert, den Sie mit einer Umgebungsvariable festlegen können. Um auf einen anderen als den Standard-Axe Reports-Server hochzuladen, verwenden Sie die --axe-reports-url-Option.

Abrufen eines API-Schlüssels

Um einen API-Schlüssel zu erhalten, wenden Sie sich direkt an Ihren Deque-Vertreter, erreichen Sie uns über unseren Support Desk oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne weiter.

Ergebnisse erzeugen

Es gibt mehrere Möglichkeiten, Ergebnisse für den Upload zu Axe Reports zu generieren. Dieser Abschnitt enthält Links zu Beispielcode, der zeigt, wie Zugänglichkeitsergebnisse generiert werden.

Für Node.js- und JavaScript-Beispiele siehe Codebeispiele für das @axe-devtools/reporter-Paket