Web-Zugänglichkeits-API – HTML-Zugänglichkeit über REST API validieren
Was ist die Web-Zugänglichkeits-API?
Die Aspose.HTML Cloud Web-Zugänglichkeits-API ermöglicht es Ihnen, die Zugänglichkeit von HTML-Dokumenten gemäß den WCAG-Standards zu überprüfen. Diese API stellt sicher, dass Ihre Webinhalte für alle Benutzer zugänglich sind, einschließlich Menschen mit Behinderungen, 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.
- Einzelner Endpunkt: Alle Zugänglichkeitsvalidierungen werden über einen einzigen Endpunkt durchgeführt:
POST https://api.aspose.cloud/v4.0/html/accessibility
. - Flexible Eingabe: Sie können HTML von einer URL, rohem HTML-Inhalt, base64-kodiertem Inhalt oder in Aspose Cloud Storage gespeicherten Dateien validieren.
Wie es funktioniert
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 gibt einen detaillierten Bericht zurück, der angibt, ob das Dokument die Zugänglichkeitsprüfungen besteht, und liefert Informationen über gefundene Probleme.
Anfrageobjekt
Der Anfragekörper sollte ein JSON-Objekt mit den folgenden Eigenschaften sein:
InputPath
: URL oder Speicherpfad zur HTML-DateiInputBase64
: base64-kodierter HTML-InhaltInputContent
: roher HTML-InhaltStorageName
: (optional) Speichername bei Verwendung von Aspose Cloud StorageOptions
: Optionen zur Zugänglichkeitsvalidierung (siehe unten)
AccessibilityOptions
Mit dem Options
-Objekt können Sie steuern, welche Zugänglichkeitsregeln und -funktionen geprüft werden. Die verfügbaren Eigenschaften sind:
AllLevels
,LowestLevel
,MiddleLevel
,HighestLevel
: welche WCAG-Stufen zu überprüfen sindWcagVersion
: WCAG-Version (z.B. “2.1”)UseHtml
,UseCss
,UseScript
,UseFailures
,UseGeneral
,UseAria
: bestimmte Validierungstypen aktivieren/deaktivierenHtmlTags
,ExcludeTags
: durch Kommas getrennte Listen von Tags zum Einschließen/AusschließenMaxErrorsPerRule
: Begrenzung der Fehler pro Regel
Detaillierte Optionsbeschreibungen:
AllLevels
(bool?): Alle WCAG-Stufen prüfen (A, AA, AAA).LowestLevel
(bool?): Nur WCAG-Stufe A prüfen (niedrigste Stufe).MiddleLevel
(bool?): Nur WCAG-Stufe AA prüfen (mittlere Stufe).HighestLevel
(bool?): Nur WCAG-Stufe AAA prüfen (höchste Stufe).WcagVersion
(string): Zu verwendende 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): Durch Kommas getrennte Liste von HTML-Tags zur Validierung (z.B. “img,button,input”).ExcludeTags
(string): Durch Kommas getrennte Liste von HTML-Tags, die von der Validierung ausgeschlossen werden sollen.MaxErrorsPerRule
(int?): Maximale Anzahl der zu meldenden Fehler pro Regel.
Sie können diese Optionen kombinieren, um die Zugänglichkeitsvalidierung nach Ihren Bedürfnissen anzupassen. Zum Beispiel können Sie nur bestimmte WCAG-Stufen prüfen, sich auf bestimmte Tags konzentrieren oder bestimmte Arten der Validierung aktivieren/deaktivieren.
Antwortobjekt
Die Antwort enthält:
Success
: Gesamtergebnis bestanden/nicht bestandenRules
: Liste der Validierungsregeln und ihrer ErgebnisseError
: Fehlermeldung, wenn die Validierung fehlgeschlagen ist
Weitere Einzelheiten finden Sie in der API-Referenz.
Gemeinsame Funktionalität
- Authentifizierung: Verwenden Sie Ihre Aspose Cloud-Anmeldedaten, um Anfragen zu authentifizieren. Siehe Authentifizierungsleitfaden für Details.
- Lokale Dateien hochladen: Um eine lokale Datei zu validieren, laden Sie sie zuerst in Aspose Cloud Storage hoch. Siehe Dateien hochladen für Anweisungen.
Die Web-Zugänglichkeits-API ist nur über die REST API verfügbar und nicht in SDKs enthalten.