Axe DevTools for Web APIについて

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

Node.js と JavaScript、C#、Java、Python、Ruby のための Axe DevTools for Web APIs の紹介。

Not for use with personal data

Dequeは、Node.js と JavaScriptC#JavaPythonRubyを含むウェブ開発およびスクリプト言語のAPIバインディングを提供しています。これらのAPIを使用することで、既存の自動テストランや継続的インテグレーション(CI)ビルドの一環として、ウェブサイトのアクセシビリティ欠陥をスキャンできます。

開始方法

Axe DevTools for Webの例 を参照して、API使用方法を示すGitHub上の事前に作成されたサンプルプロジェクトのカタログを確認してください。これらのプロジェクトをクローンして、すぐに動作するサンプルを始めることができます。各プロジェクトのREADME.mdで、ステップバイステップの開始手順を確認してください。

APIドキュメント

Axe DevTools for Webはさまざまな言語とフレームワークをサポートしており、以下のリンクからドキュメントを参照できます。

新しいDeque開発者のための基本

Axe DevTools for Web APIの使用が初めての方は、始める前に確認しておくとよいトピックがいくつかあります。

インストール

Dequeのライブラリとパッケージを入手するには、いくつかの方法があります。インストールに関する詳細は、以下のトピックを参照してください。

デフォルトのルールセット

別の設定を行わない限り、Axe DevTools for Web APIはWCAG 2.1 レベルAA、ルールセットIDwcag2.1に対してテストします。そのデフォルトでは、タグ付けされたbest-practiceルールとexperimentalルールはオフになります。デフォルトが何をカバーしているか、各言語でベストプラクティスを有効にする方法、異なる基準を選択する方法についてはルールのカスタマイズをご覧ください。

iframe の解析

<iframe> 要素内のコンテンツは、ページの残りの部分と一緒に、サポートされているすべての言語で分析されます。フレームの結果がどのように報告されるか、およびフレーム内の要素に分析を限定する方法については、iframe の解析 を参照してください。

アクセシビリティトレーニング

Deque University を参照して、アクセシビリティとアクセシビリティ標準に関する情報とトレーニングを確認してください。アクセシビリティについて学ぶことで、より経済的に問題を修正できるソフトウェア開発ライフサイクルの初期段階で、アクセシビリティの問題に対処できるようになります。

axe-core

オープンソースライブラリの axe-core は、すべての Axe DevTools for Web パッケージやライブラリの基盤です。詳細については axe-core GitHub リポジトリ をご覧ください。

note

Deque の API パッケージ(Node.js Reporter パッケージを除く)は、厳密には セマンティック バージョニング 規則に従っていません。これらのパッケージは、メジャーおよびマイナーバージョンの番号を、axe-core の依存関係のメジャーおよびマイナーバージョンに固定し、パッチバージョンのみが異なる可能性があります。(例えば、API バージョンが 4.7.2 の場合、パッケージが使用する axe-core のバージョンは 4.7.x になります。)セマンティックバージョニングとの違いは、パッケージのパッチバージョンにはバグ修正だけでなく、他の更新が含まれる可能性があることです 新しいAPI機能。(ただし、パッチバージョンが破壊的変更を導入することはありません。)