API веб-доступности на C#
Проверяйте HTML по правилам WCAG на C#, находите проблемы доступности и экспортируйте результаты проверки.
Проверка веб-доступности с помощью .NET API
Aspose.HTML for .NET предоставляет API для проверки доступности HTML-файлов и веб-страниц. Пространство имён Aspose.Html.Accessibility позволяет выполнить полную проверку или выбрать правила для отдельных проблем, например отсутствующего альтернативного текста изображений и недостаточной цветовой контрастности.
Доступный HTML помогает людям, которые используют программы экранного доступа, клавиатурную навигацию, увеличение экрана и другие вспомогательные технологии. Регулярные проверки позволяют разработчикам раньше находить проблемы и поддерживать соответствие страниц требованиям WCAG при изменении контента.
Выбор сценария проверки веб-доступности
| Задача разработки | Рекомендуемый сценарий |
|---|---|
| Выполнить полную проверку доступности и изучить найденные проблемы | Валидатор доступности HTML |
| Проверить HTML-документ по выбранным правилам WCAG | Правила доступности WCAG |
Найти отсутствующие или неправильно используемые атрибуты alt | Проверка атрибутов alt |
| Проверить минимальные и повышенные требования к контрастности текста | Проверка цветового контраста |
Проверка HTML по уровням WCAG A и AA
В этом примере выбираются критерии WCAG уровней A и AA, а также правила для технологий HTML и CSS. Код проверяет документ и экспортирует найденные ошибки и предупреждения.
Код C# для настройки проверки веб-доступности
using System;
using System.IO;
using Aspose.Html;
using Aspose.Html.Accessibility;
using Aspose.Html.Accessibility.Results;
string documentPath = Path.Combine("data", "input.html");
WebAccessibility webAccessibility = new WebAccessibility();
// Select WCAG Level A and AA checks for HTML and CSS technologies
ValidationBuilder validationPolicy = ValidationBuilder.None
.UseHTML()
.UseCSS()
.UseLowestLevel()
.UseMiddleLevel();
AccessibilityValidator validator = webAccessibility.CreateValidator(
validationPolicy);
// Validate the document and export detected issues
using HTMLDocument document = new HTMLDocument(documentPath);
ValidationResult validationResult = validator.Validate(document);
Console.WriteLine($"Validation passed: {validationResult.Success}");
if (!validationResult.Success)
{
Console.WriteLine(validationResult.SaveToString());
}
Как настроить проверку веб-доступности
- Выберите область проверки – все доступные проверки, заданные уровни и технологии, объект иерархии WCAG или явный список правил.
- Создайте объект WebAccessibility и настройте AccessibilityValidator .
- Загрузите локальный файл или URL веб-страницы в HTMLDocument .
- Вызовите
Validate()и обработайте возвращённый объект ValidationResult . - Сохраните результаты автоматической проверки, исправьте исходный документ и выполните необходимые ручные тесты доступности.
Возможности API веб-доступности
- Настраиваемая проверка. Используйте все правила репозитория или фильтруйте проверки по уровню соответствия, технологии, HTML-тегу, принципу, рекомендации, критерию или коду правила.
- Целевые проверки. Настраивайте отдельные сценарии для альтернативного текста, меток, структуры документа, цветовой контрастности и других поддерживаемых требований.
- Подробные результаты. Анализируйте результаты правил и техник, типы и сообщения об ошибках, а также связанные с ними элементы HTML или CSS.
- Экспорт отчётов. Сохраняйте результаты в форматах TXT, JSON или XML для анализа, журналов и автоматизированного контроля качества.
- Интеграция в приложения. Запускайте одну политику при обработке контента, проверке CMS, тестировании или в конвейерах CI/CD.
- Определённые ограничения. Автоматические проверки помогают оценивать доступность, но не подтверждают полное соответствие WCAG без ручной проверки.
Для разовой проверки без написания кода используйте онлайн-сервис Web Accessibility Checker .
Документация по веб-доступности
Начните со статьи Как проверить веб-доступность на C# . Настройка валидатора описана в руководстве Accessibility Validator – проверка доступности по WCAG , иерархия репозитория – в статье Правила веб-доступности , а форматы отчётов – в статье Сохранение результатов проверки веб-доступности .
Установка Aspose.HTML for .NET
Установите Aspose.HTML for .NET из NuGet с помощью .NET CLI:
dotnet add package Aspose.HTML
Также можно использовать интерфейс диспетчера пакетов NuGet или выполнить Install-Package Aspose.HTML в консоли диспетчера пакетов. Подробные инструкции приведены в
руководстве по установке
. Чтобы протестировать API без ограничений ознакомительной версии, запросите
временную лицензию
.
Вопросы об API веб-доступности
1. Какие проверки доступности можно автоматизировать с Aspose.HTML for .NET?
API позволяет проверять HTML по поддерживаемым правилам доступности, включая альтернативный текст, метки, структуру, CSS и цветовой контраст. Доступный набор проверок зависит от выбранных правил, технологий и уровней соответствия.
2. Следует проверять все правила или выбрать только необходимые?
Для общей оценки используйте полную проверку. Выбирайте уровни, технологии, теги, критерии или отдельные коды правил, если в проекте определена собственная политика или нужна быстрая проверка конкретного компонента. Ограниченный набор правил нельзя считать полным аудитом.
3. Можно ли запускать проверку веб-доступности в CI/CD?
Да. Запускайте валидатор во время тестирования или сборки контента, экспортируйте результаты и задайте условия проекта, при которых конвейер должен вывести предупреждение или завершиться с ошибкой. Ручное тестирование доступности остаётся отдельной частью подготовки выпуска.
Другие возможности Aspose.HTML for .NET
Перейдите к инструментам и руководствам по редактированию, созданию, генерации и конвертации HTML-контента.