Hochladen von JSON-Zugänglichkeitsergebnissen zu Axe Reports
Verwendung des Unterbefehls bulk-reports zum Hochladen von Ergebnissen zu Axe Reports
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.
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>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-reportsOptionen
| 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) Gibt die URL des Servers an, auf den die Berichte hochgeladen werden. |
Umgebungsvariablen
| 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. |
AXE_REPORTS_URL |
(Optional) Gibt die URL an, wohin die Ergebnisse hochgeladen werden. Üblicherweise ist dies die Adresse des Axe Reports-Servers. |
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
Für andere Sprachen siehe:
- Für C# siehe Berichte mit C# erzeugen.
- Für Java siehe Berichte mit Java erzeugen.
- Für Python siehe Berichte mit Python erzeugen.
