AsyncAPI Validator

Detta verktyg validerar AsyncAPI-dokument för att säkerställa att de är välformade, syntaktiskt korrekta och överensstämmer med AsyncAPI v2-specifikationer. Det riktar sig till API-designers, plattformsingenjörer, QA-team och tekniska författare som publicerar eller granskar händelsestyrda kontrakt, kanaler, meddelanden och payload-scheman. Genom att ta emot YAML eller JSON kontrolleras obligatoriska avsnitt, strukturell integritet och mönster såsom servrar, kanaler, meddelanden och bindings. Valideraren generar en detaljerad rapport med fel, varningar och åtgärdsvägledning.
Den centrala valideringslogiken analyserar indata med en robust schemadesparser, löser referenser och upprätthåller konformitetsregler. Den utför syntaxvalidering, schema-validering och korsfältskontroller (t.ex. att en kanal har minst en operation och att payload-scheman definierats). Valfria lägen ger strängare kontroller, som krav på lösbara externa referenser eller genomförande av namngivningskonventioner och dialekt-specifika begränsningar.
Vanliga användningsfall inkluderar validering av ett utkast till AsyncAPI-dokument innan det skickas till repositoryt, granskning av ett befintligt specifikation för fullständighet och konsekvens samt generering av maskinläsbara rapporter för CI-pipelines eller dokumentationsverktyg. Verktyget är utformat för offline- eller begränsade miljöer där ingen körningstrafik existerar. Det fokuserar på designtidens kvalitet snarare än körningstiden.
Begränsningar och omfattning: valideraren granskar endast syntax, struktur och deklarerade scheman. Det är inte en körningstidsvaliderare och kan inte garantera API-beteende eller affärslogik. Det flaggar föråldrade fält, otillgängliga tillägg och potentiella tvetydigheter. Det stödjer standardfunktioner i AsyncAPI v2 och vanliga dialekter och förblir neutral vad gäller lokalisering; felmeddelanden kan genereras på det konfigurerade språket.