アクセシビリティ結果をJavaで利用する
アクセシビリティ結果のフォーマットに関する情報
Axe DevToolsスキャンの結果を活用する方法は、事実上無限です
すべてのaxe-core駆動のアクセシビリティスキャンは、結果をJSONオブジェクトとして返すように設定できます。このフォーマットは、ウェブアクセシビリティ初心者にも簡単に利用可能であり、経験豊富な専門家が必要とする詳細な情報を含み、標準的なアサーションベースのテスト形式以外でも自動レポート生成やカスタムテストを可能にします。
結果オブジェクトを生成する
結果オブジェクトを生成するには、Javaでレポートを生成する を参照してください
結果の概要
メタ情報
結果オブジェクトは、有用なメタ情報から始まります。これには、テストの名前、テストされたページのウェブアドレス、テスト実施の日付と時刻、使用されたaxe-coreルールセットなどが含まれます。
発見事項
結果の最初は「発見事項」の見出しで示されています。結果にはそれぞれ独自の配列を持つ4つのタイプがあります。これらは適用不可、不完全、合格、および違反です。さらに、違反配列の直前にはテストの特定データがあります。
適用不可
適用不可は、その特定のテストに関連するページ内容がなかった場合を意味します。たとえば、フォームのないページのフォーム関連のテストなどです。
不完全
不完全はテストが実施されましたが、結果が最終的にどのカテゴリーに入るべきかを判断するためにさらなるレビューが必要です。一般的な不完全のケースは、色のコントラストのチェックで、背景色が変動する要素です。十分なコントラストが得られているか明確でない場合があります。このカテゴリーの問題は直ちに違反として扱われるべきではありません。アクセシビリティの知識が豊富なユーザーにとって、これらの結果を詳細に調べることは、自動的にテストできない追加の違反を見つけるのに役立ちます。
合格
この結果グループは、チェックされたルールに関連するアクセシビリティ違反が見つからなかったことを列挙しています。各合格したルールに関連して、ルールに対してチェックされ合格したページ要素の配列があります。
違反
違反配列には、スキャンで見つかったすべてのアクセシビリティ違反が含まれています。Dequeのゼロ誤検知ポリシーのおかげで、ここで見つかった結果は本物であることが保証されています。各違反には、その違反が何であるか、ページ上の場所、修正方法に関する提案など、さらに詳しい情報が含まれています。詳しくは以下のフィールドリファレンスをご覧ください。
フィールドリファレンス - 合格および違反
- description — ルールが何をするかを説明するテキスト文字列
- help — 実施されたテストを説明するヘルプテキスト
- helpUrl — 違反の詳細に関する情報を提供するURL。Deque Universityのサイト上のページへのリンクです。
- id — ルールの一意の識別子。ルールのリストを参照してください。
- impact — 違反の深刻度です。テストが失敗した場合はminor、moderate、serious、またはcriticalのいずれかであり、チェックが合格した場合はnullです。
- tags — このルールに割り当てられたタグの配列です。これらのタグは、オプション構造でどのルールを実行するかを選択するために使用できます。
- nodes — ルールがテストしたすべての要素の配列
- html — 要素のHTMLスニペット
- impact — 違反の深刻度です。テストが失敗した場合はminor、moderate、serious、またはcriticalのいずれかであり、チェックが合格した場合はnullです。
- target — セレクターの配列で、各要素がiframeまたはフレームの1レベルに対応します。iframeまたはフレームが1つの場合、targetには2つのエントリがあるべきです。iframeのレベルが3つある場合、targetには4つのエントリがあるべきです。
- any — 配列内で少なくとも1つが合格しているべきチェックの配列です。配列の各エントリには以下が含まれます：
- id — このチェックの一意の識別子。チェックのIDはルールIDと同じ場合があります
- impact — この特定のチェックの深刻度です。minor、moderate、serious、またはcriticalのいずれかです。ルールの一部である各チェックは異なるインパクトを持つことができます。失敗したすべてのチェックの最高のインパクトがルールに報告されます
- message — このチェックがなぜ合格または失敗したのかの説明
- data — 任意のチェックタイプに特有の追加情報です。例として、色のコントラストチェックは前景色、背景色、コントラスト比などを含みます。
- relatedNodes — このチェックに関連する他のノードに関する情報のオプション配列です。たとえば、重複IDチェックの違反は、同じ重複IDを持つ他のセレクターをリストします。配列内の各エントリには以下の情報が含まれます：
- target — 関連ノードのセレクターの配列
- html — 関連ノードのHTMLソース
- all — すべて合格しているべきチェックの配列。配列内の各エントリは、any配列と同じ情報を含みます
- none — すべてが不合格であるべきチェックの配列。配列内の各エントリは、any配列と同じ情報を含みます
結果の使用法
Dequeは、あなたのスキャン結果を簡単に共有し、解釈するためにレポーターを提供します。HTML、JUnit XML、またはCSVレポートを生成するように設定でき、一度設定すればレポートが自動的に返されます。レポートに関するガイドを参照してレポーターの設定と使用方法を学んでください。
さらに、JSONの結果オブジェクトを使うことで、独自のカスタムテストを簡単に作成できます。標準のアクセシビリティ違反のアサーションを超えて、結果オブジェクトを違反、重大度、影響、関連するルールセット、または結果オブジェクトのパラメーターのいずれかで分割することができます。結果オブジェクトにレイアウトされたデータは、したがってすべてテスト対象となります。