Uploading Your Accessibility Results to axe Developer Hub

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

Using axe Developer Hub with the Java APIs

Not for use with personal data

You can upload your accessibility results to axe Developer Hub and use its features to track fixes to accessibility problems.

There are two steps to follow to upload your results from the web APIs to axe Developer Hub, as shown in the following diagram:

This diagram shows how you can use the axe CLI to upload your accessibility results to axe Developer Hub. First, your web API writes a .json results file to disk. Second, use the axe command-line interface tool to upload these .json results to axe Developer Hub by supplying a file name for your results, your personal API key, and your project ID to the tool.

  1. Your test code writes results (a .json file containing your accessibility results) to disk. Modify your test code to create an accessibility results file. See Creating Accessibility Results below for more information about modifying your code.

  2. Use the CLI tool axe with the devhub subcommand to upload your results to axe Developer Hub by specifying the results file, your personal API key, and your project ID. For example:

    axe devhub <results.json> --axe-devhub-api-key <API-key> --axe-devhub-project-id <project-ID>

See Uploading to axe Developer Hub for more information about using the CLI to upload results to axe Developer Hub.

Creating Accessibility Results

You can use logResults() method to write .json results files for use with the axe CLI tool. See Use the Results and Generating Reports with Java for examples of its use.

note

You do not need to use the Reporter binary as mentioned in Generating Reports with Java. You only need to create a results object and then write it to disk as a .json file.

Is this page helpful?

Help us improve this page

Still need help?