AsyncAPI Validator

Dieses Tool validiert AsyncAPI-Dokumente, um sicherzustellen, dass sie gut formatiert, syntaktisch korrekt und konform mit AsyncAPI v2-Spezifikationen sind. Es richtet sich an API-Designer, Plattformingenieure, QA-Teams und technische Redakteure, die ereignisgesteuerte Verträge, Kanäle, Nachrichten und Payload-Schemata veröffentlichen oder überprüfen. Indem YAML oder JSON akzeptiert wird, prüft es erforderliche Abschnitte, strukturelle Integrität und Muster wie Server, Kanäle, Nachrichten und Bindings. Der Validator erzeugt einen detaillierten Bericht mit Fehlern, Warnungen und Abhilfemaßnahmen.
Die zentrale Validierungslogik analysiert die Eingabe mit einem robusten Schema-Parser, löst Referenzen auf und erzwingt Konformitätsregeln. Sie führt Syntax-Validierung, Schema-Validierung und Felderübergreifende Prüfungen durch (zum Beispiel sicherzustellen, dass ein Kanal mindestens eine Operation hat und dass Payload-Schemas definiert sind). Optionalen Modi ermöglichen strengere Prüfungen, z. B. das Erfordernis auflösbarer externer Referenzen oder die Durchsetzung von Namenskonventionen und dialekt-spezifischen Beschränkungen.
Häufige Anwendungsfälle umfassen die Validierung eines Entwurfs-AsyncAPI-Dokuments vor der Repository-Einreichung, die Prüfung eines bestehenden Specs auf Vollständigkeit und Konsistenz sowie die Erzeugung maschinenlesbarer Berichte für CI-Pipelines oder Dokumentationstools. Das Tool ist für Offline- oder eingeschränkte Umgebungen konzipiert, in denen kein Laufzeitverkehr entsteht. Es fokussiert sich auf Design-Qualität statt Laufzeitverhalten.
Einschränkungen und Umfang: Der Validator prüft nur Syntax, Struktur und deklarierte Schemata. Es ist kein Laufzeit-Validator und kann das API-Verhalten oder die Geschäftslogik nicht garantieren. Es kennzeichnet veraltete Felder, nicht unterstützte Erweiterungen und potenzielle Mehrdeutigkeiten. Es unterstützt Standard-AsyncAPI-v2-Funktionen und gängige Dialekte und bleibt neutral gegenüber Lokalisierung; Fehlermeldungen können in der konfigurierten Sprache erzeugt werden.