AsyncAPI Validator

Questo strumento convalida i documenti AsyncAPI per garantire che siano ben formati, sintatticamente corretti e conformi alle specifiche AsyncAPI v2. Si rivolge a designer API, ingegneri di piattaforma, team QA e redattori tecnici che pubblicano o revisionano contratti basati su eventi, canali, messaggi e schemi di payload. Accettando YAML o JSON, verifica sezioni obbligatorie, integrità strutturale e schemi come server, canali, messaggi e binding. Il validatore produce un rapporto dettagliato con errori, avvisi e indicazioni di remediation.
La logica di validazione centrale analizza l’input con un robusto parser di schemi, risolve referenze e applica le regole di conformità. Esegue validazione della sintassi, validazione dello schema e controlli incrociati tra campi (ad esempio assicurando che un canale abbia almeno una operazione e che gli schemi di payload siano definiti). Modalità opzionali permettono controlli più severi, come requisiti per referenze esterne risolvibili o l’imposizione di convenzioni di naming e vincoli di dialetto.
Usi comuni includono convalidare un documento AsyncAPI in bozza prima di presentarlo al repository, verificare una specifica esistente per completezza e coerenza, e produrre rapporti leggibili da macchina per CI o strumenti di documentazione. Lo strumento è progettato per ambienti offline o limitati dove non si effettua traffico di runtime. Si concentra sulla qualità di progettazione piuttosto che sul comportamento a runtime.
Limitazioni e ambito: il validatore esamina solo sintassi, struttura e schemi dichiarati. Non è un validatore a runtime e non può garantire comportamento API o validità logica di business. Evidenzia campi deprecati, estensioni non supportate e ambiguità potenziali. Supporta funzionalità standard di AsyncAPI v2 e dialetti comuni; rimane neutro rispetto alla localizzazione; i messaggi di errore possono essere prodotti nella lingua configurata.