Web Accessibility API – Проверка доступности HTML через REST API

Что такое Web Accessibility API?

Aspose.HTML Cloud Web Accessibility API позволяет проверить доступность HTML-документов в соответствии со стандартами WCAG. Этот API помогает обеспечить доступность вашего веб-контента для всех пользователей, включая людей с ограниченными возможностями, проверяя соответствие различным уровням WCAG (A, AA, AAA).

• Только REST API: Этот API не включен в SDK и доступен исключительно через прямые HTTP-запросы.
• Единая конечная точка: Вся проверка доступности выполняется через единую конечную точку: POST https://api.aspose.cloud/v4.0/html/accessibility.
• Гибкий ввод: Вы можете проверить HTML из URL, необработанного HTML-контента, контента в кодировке base64 или файлов, хранящихся в Aspose Cloud Storage.

Как это работает

Для проверки доступности отправьте POST-запрос к конечной точке с объектом AccessibilityRequest. Запрос может указать источник HTML (URL, контент, base64 или путь к хранилищу) и различные параметры проверки. API возвращает подробный отчет, указывающий, прошел ли документ проверки доступности, и предоставляет информацию о найденных проблемах.

Объект запроса

Тело запроса должно быть JSON-объектом со следующими свойствами:

• InputPath: URL или путь к хранилищу HTML-файла
• InputBase64: HTML-контент в кодировке base64
• InputContent: необработанный HTML-контент
• StorageName: (опционально) имя хранилища при использовании Aspose Cloud Storage
• Options: параметры проверки доступности (см. ниже)

AccessibilityOptions

Объект Options позволяет контролировать, какие правила доступности и функции проверяются. Доступные свойства:

• AllLevels, LowestLevel, MiddleLevel, HighestLevel: какие уровни WCAG проверять
• WcagVersion: версия WCAG (например, “2.1”)
• UseHtml, UseCss, UseScript, UseFailures, UseGeneral, UseAria: включить/отключить определенные типы проверки
• HtmlTags, ExcludeTags: списки тегов для включения/исключения через запятую
• MaxErrorsPerRule: ограничение ошибок на правило

Подробные описания параметров:

• AllLevels (bool?): Проверить все уровни WCAG (A, AA, AAA).
• LowestLevel (bool?): Проверить только уровень WCAG A (самый низкий уровень).
• MiddleLevel (bool?): Проверить только уровень WCAG AA (средний уровень).
• HighestLevel (bool?): Проверить только уровень WCAG AAA (самый высокий уровень).
• WcagVersion (string): Версия WCAG для проверки (например, “2.1”).
• UseHtml (bool?): Включить проверку HTML.
• UseCss (bool?): Включить проверку CSS.
• UseScript (bool?): Включить проверку JavaScript.
• UseFailures (bool?): Включить проверку ошибок (проверяет известные сбои).
• UseGeneral (bool?): Включить общую проверку (широкие проверки доступности).
• UseAria (bool?): Включить проверку ARIA (проверяет ARIA-атрибуты и роли).
• HtmlTags (string): Список HTML-тегов для проверки через запятую (например, “img,button,input”).
• ExcludeTags (string): Список HTML-тегов для исключения из проверки через запятую.
• MaxErrorsPerRule (int?): Максимальное количество ошибок для отчета по правилу.

Вы можете комбинировать эти параметры для настройки проверки доступности в соответствии с вашими потребностями. Например, вы можете проверить только определенные уровни WCAG, сосредоточиться на конкретных тегах или включить/отключить определенные типы проверки.

Объект ответа

Ответ содержит:

• Success: общий результат (пройдено/не пройдено)
• Rules: список правил проверки и их результатов
• Error: сообщение об ошибке в случае неудачной проверки

См. Справочник API для полной информации.

Методы проверки

Web Accessibility API предоставляет несколько методов для проверки доступности HTML:

• Проверка по URL - Проверить доступность веб-страницы по её URL
• Проверка по HTML-контенту - Проверить необработанный HTML-контент
• Проверка по Base64 - Проверить HTML в кодировке base64
• Проверка локального файла - Загрузить и проверить локальный HTML-файл

Общая функциональность

• Аутентификация: Используйте свои учетные данные Aspose Cloud для аутентификации запросов. См. Руководство по аутентификации для получения подробной информации.
• Загрузка локальных файлов: Для проверки локального файла сначала загрузите его в Aspose Cloud Storage. См. Загрузка файлов для инструкций.