AsyncAPI Validator

Dette værktøj validerer AsyncAPI-dokumenter for at sikre, at de er velstrukturerede, syntaktisk korrekte og i overensstemmelse med AsyncAPI v2-specifikationerne. Det henvender sig til API-designere, platformingeniører, QA-teams og tekniske skribenter, der publicerer eller gennemgår begivenhedsconfigurede kontrakter, kanaler, beskeder og payload-schemata. Ved at acceptere YAML eller JSON kontrollerer det krævede sektioner, strukturel integritet og mønstre som servers, kanaler, beskeder og bindings. Validatoren producerer en detaljeret rapport med fejl, advarsler og afhjælpningstips.
Kernen i valideringslogikken analyserer inddata med en robust skemavalider, løser referencer og håndhæver overensstemmelsesregler. Den udfører syntaksvalidering, skemavalidering og krydsfeltkontroller (f.eks. at en kanal har mindst én operation, og at payload-schemata er defineret). Valgfrie tilstande giver strengere kontroller, såsom krav om løselige eksterne referencer eller håndhævelse af navngivningskonventioner og dialekt-specifikke begrænsninger.
Anvendelsesområder inkluderer validering af et udkast til AsyncAPI-dokument før submission til et repository, gennemgang af en eksisterende specifikation for fuldstændighed og konsistens, og produktion af maskinlæsbare rapporter til CI-pipelines eller dokumentationsværktøjer. Værktøjet er designet til offline eller begrænsede miljøer, hvor ingen køretids trafik udøves. Fokus ligger på designkvalitet frem for køretidens adfærd.
Begrænsninger og omfang: Validatoren undersøger kun syntaks, struktur og erklærede skemaer. Det er ikke en runtime-validator og kan ikke garantere API-opførsel eller forretningslogik. Det markerer forældede felter, ikke-understøttede udvidelser og potentielle tvetydigheder. Det understøtter standard AsyncAPI v2-funktioner og almindelige dialekter og forbliver neutral til lokalisering; fejlmeddelelser kan genereres på det konfigurerede sprog.