JSONアクセシビリティ結果をAxe Reportsにアップロードする
bulk-reportsサブコマンドを使用して結果をAxe Reportsにアップロードする
CLIを使用して結果をAxe Reportsに送信するには、サブコマンドbulk-reportsを使用します。APIキーが必要であり、これはAPIキーの取得で説明されています。
このコマンドが使用する結果ファイルを作成するには、以下のセクション結果の生成を参照してください。
bulk-reportsで結果をアップロードしても、Axeレポート（月ごとの使用状況とスキャンされたURLレポート）の使用指標は反映されません。それらは代わりに使用状況サービスによって反映されます。Axeレポートで使用状況データを表示を参照してください。
bulk-reportsコマンド
axe bulk-reports <results-dir> --send-axe-reports --axe-reports-api-key <api-key>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-reports-dimensions | （オプション）Axe Reportsでスキャンを分類するために使用されるJTBD（やるべきこと）次元のカンマ区切りリスト。JTBD次元を参照してください。 |
JTBD次元
--axe-reports-dimensionsオプションは、アップロードされた結果に1つまたは複数のJTBD（やるべきこと）次元をタグ付けし、Axe Reportsでスキャンをグループ化およびフィルタリングできるようにします。次元は、チーム名、リリース、アプリケーションエリアなどの自由形式のラベルであり、有効な値の固定セットはありません。複数の次元をカンマで区切ります：
axe bulk-reports ./results --send-axe-reports --axe-reports-api-key <your-API-key> --axe-reports-dimensions checkout,mobile-web次元はアップロードされたペイロード内のプロジェクトに記録され、個々のページには記録されません。したがって、アップロード全体を記述するものです。
同じオプションは、単一ページのテスト（--axe-reports-dimensionsを参照）またはワークフロースペックファイルの実行時にも利用可能です。
環境変数
| 変数 | 説明 |
|---|---|
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でレポートを生成するを参照してください。