JSONアクセシビリティ結果をaxe Reportsにアップロードする
bulk-reportsサブコマンドを使用してaxe Reportsに結果をアップロードする
Not for use with personal data
CLIを使用してサブコマンドbulk-reportsで結果をaxe Reportsに送信できます。APIキーが必要であり、それについてはAPIキーの取得で説明します。
このコマンドが使用する結果ファイルを作成するには、以下のセクション結果の生成を参照してください。
bulk-reportsコマンド
axe bulk-reports <results-dir> --send-axe-reports --axe-reports-api-key <api-key> note
axe Reportsは、レポートディレクトリにJSON結果ファイルが含まれていることを必要とします。
例
axe bulk-reports ./results --axe-reports-api-key 720abdd2-03a3-41bf-b820-0cc38af67057 --send-axe-reportsオプション
| オプション | 説明 |
|---|---|
| --send-axe-reports | axeレポートを一括でアップロードすることを示すために必要です。 |
| --axe-reports-api-key | Dequeのaxe Reportsサービスにレポートをアップロードするために必要なAPIキーです。 |
| --axe-reports-url | (オプション)レポートがアップロードされるサーバーのURLを示します。 |
環境変数
| 変数 | 説明 |
|---|---|
| AXE_REPORTER_API_KEY | axe Reports APIキー。APIキーの取得については、APIキーの取得を参照してください。環境変数にAPIキーを入れることで、Gitリポジトリにチェックインされたファイルに追加するのを避けることができます。 |
| AXE_REPORTS_URL | (オプション)結果がアップロードされるURLを指定します。通常はaxe Reportsサーバーのアドレスです。 |
APIキーの取得
APIキーを取得するには、直接Dequeの担当者に連絡するか、サポートデスクを通じて、またはメールを送るしてください。喜んでお手伝いします。
結果の生成
axe Reportsにアップロードする結果を生成する方法はいくつかあります。このセクションには、アクセシビリティ結果の生成方法を示すサンプルコードへのリンクが含まれています。
Node.jsとJavaScriptの例については、@axe-devtools/reporterパッケージのコードサンプルを参照してください
他の言語については、以下を参照してください:
- C#については、C#でレポートを生成するを参照してください。
- Javaについては、Javaでレポートを生成するを参照してください。
- Pythonについては、Pythonでレポートを生成するを参照してください。
