Web Accessibility API – HTML-Zugänglichkeit per REST API validieren

Was ist die Web Accessibility API?

Die Aspose.HTML Cloud Web Accessibility API ermöglicht die Validierung der Zugänglichkeit von HTML-Dokumenten gemäß den WCAG Standards. Diese API hilft sicherzustellen, dass Ihre Webinhalte für alle Nutzer, einschließlich Menschen mit Behinderungen, zugänglich sind, indem sie die Einhaltung verschiedener WCAG-Stufen (A, AA, AAA) überprüft.

• Nur REST API: Diese API ist nicht in SDKs enthalten und ausschließlich über direkte HTTP-Anfragen verfügbar.
• Ein Endpunkt: Die gesamte Zugänglichkeitsprüfung erfolgt über einen einzigen Endpunkt: POST https://api.aspose.cloud/v4.0/html/accessibility.
• Flexible Eingabe: Sie können HTML aus einer URL, rohem HTML-Inhalt, Base64-codiertem Inhalt oder aus Dateien im Aspose Cloud Storage validieren.

Funktionsweise

Um die Zugänglichkeit zu validieren, senden Sie eine POST-Anfrage an den Endpunkt mit einem AccessibilityRequest-Objekt. Die Anfrage kann die HTML-Quelle (URL, Inhalt, Base64 oder Speicherpfad) und verschiedene Validierungsoptionen angeben. Die API liefert einen detaillierten Bericht, der angibt, ob das Dokument die Zugänglichkeitsprüfungen besteht und informiert über gefundene Probleme.

Anfrageobjekt

Der Anfrage-Body sollte ein JSON-Objekt mit folgenden Eigenschaften sein:

• InputPath: URL oder Speicherpfad zur HTML-Datei
• InputBase64: Base64-codierter HTML-Inhalt
• InputContent: Roh-HTML-Inhalt
• StorageName: (optional) Speichername bei Nutzung von Aspose Cloud Storage
• Options: Optionen für die Zugänglichkeitsprüfung (siehe unten)

AccessibilityOptions

Das Options-Objekt ermöglicht die Steuerung, welche Zugänglichkeitsregeln und Funktionen geprüft werden. Die verfügbaren Eigenschaften sind:

• AllLevels, LowestLevel, MiddleLevel, HighestLevel: Welche WCAG-Stufen geprüft werden
• WcagVersion: WCAG-Version (z.B. „2.1")
• UseHtml, UseCss, UseScript, UseFailures, UseGeneral, UseAria: Aktivieren/Deaktivieren bestimmter Prüftypen
• HtmlTags, ExcludeTags: Kommagetrennte Listen von Tags zum Ein-/Ausschließen
• MaxErrorsPerRule: Fehlerbegrenzung pro Regel

Detailierte Optionsbeschreibungen:

• AllLevels (bool?): Prüft alle WCAG-Stufen (A, AA, AAA).
• LowestLevel (bool?): Prüft nur WCAG-Stufe A (niedrigste Stufe).
• MiddleLevel (bool?): Prüft nur WCAG-Stufe AA (mittlere Stufe).
• HighestLevel (bool?): Prüft nur WCAG-Stufe AAA (höchste Stufe).
• WcagVersion (string): WCAG-Version für die Validierung (z.B. „2.1").
• UseHtml (bool?): HTML-Validierung aktivieren.
• UseCss (bool?): CSS-Validierung aktivieren.
• UseScript (bool?): JavaScript-Validierung aktivieren.
• UseFailures (bool?): Fehlervalidierung aktivieren (prüft auf bekannte Fehler).
• UseGeneral (bool?): Allgemeine Validierung aktivieren (umfassende Zugänglichkeitsprüfungen).
• UseAria (bool?): ARIA-Validierung aktivieren (prüft ARIA-Attribute und -Rollen).
• HtmlTags (string): Kommagetrennte Liste von HTML-Tags zur Validierung (z.B. „img,button,input").
• ExcludeTags (string): Kommagetrennte Liste von HTML-Tags, die von der Validierung ausgeschlossen werden.
• MaxErrorsPerRule (int?): Maximale Anzahl von Fehlern pro Regel.

Sie können diese Optionen kombinieren, um die Zugänglichkeitsprüfung an Ihre Bedürfnisse anzupassen. Beispielsweise können Sie nur bestimmte WCAG-Stufen prüfen, sich auf spezifische Tags konzentrieren oder bestimmte Arten der Validierung aktivieren/deaktivieren.

Antwortobjekt

Die Antwort enthält:

• Success: Gesamtergebnis (bestanden/nicht bestanden)
• Rules: Liste der Validierungsregeln und ihrer Ergebnisse
• Error: Fehlermeldung bei fehlgeschlagener Validierung

Siehe die API-Referenz für alle Details.

Validierungsmethoden

Die Web Accessibility API bietet verschiedene Methoden zur Validierung der HTML-Zugänglichkeit:

• Validieren per URL - Zugänglichkeit einer Webseite über ihre URL validieren
• Validieren per HTML-Inhalt - Rohen HTML-Inhalt validieren
• Validieren per Base64 - Base64-codierten HTML validieren
• Lokale Datei validieren - Lokale HTML-Datei hochladen und validieren

Allgemeine Funktionalität

• Authentifizierung: Verwenden Sie Ihre Aspose Cloud-Anmeldedaten zur Authentifizierung von Anfragen. Siehe Authentifizierungsanleitung für Details.
• Lokale Dateien hochladen: Um eine lokale Datei zu validieren, laden Sie sie zuerst in den Aspose Cloud Storage hoch. Siehe Dateien hochladen für Anweisungen.