AsyncAPI Validator

Cet outil valide les documents AsyncAPI pour assurer qu’ils sont bien formés, syntaxiquement corrects et conformes aux spécifications AsyncAPI v2. Il s’adresse aux concepteurs d’API, ingénieurs de plateforme, équipes QA et rédacteurs techniques qui publient ou examinent des contrats événementiels, canaux, messages et schémas de charge utile. En acceptant YAML ou JSON, il vérifie les sections obligatoires, l’intégrité structurale et les motifs tels que serveurs, canaux, messages et bindings. Le validateur produit un rapport détaillé incluant erreurs, avertissements et conseils de remédiation.
La logique principale de validation analyse l’entrée avec un analyseur de schéma robuste, résout les références et applique les règles de conformité. Il effectue la validation syntaxique, la validation de schéma et des vérifications croisées de champs (par exemple s’assurer qu’un canal a au moins une opération et que des schémas de payload sont définis). Des modes optionnels permettent des vérifications plus strictes, comme l’exigence de références externes résolubles ou l’imposition de conventions de nommage et de contraintes spécifiques aux dialectes.
Des cas d’usage courants incluent la validation d’un document AsyncAPI en brouillon avant soumission au dépôt, l’audit d’un spec existant pour sa complétude et sa cohérence, et la production de rapports lisibles par machine pour les pipelines CI ou les outils de documentation. L’outil est conçu pour des environnements hors ligne ou restreints où aucun trafic en temps réel n’est exercé. Il se concentre sur la qualité de conception plutôt que sur le comportement en temps réel.
Limites et périmètre : le validateur examine uniquement la syntaxe, la structure et les schémas déclarés. Il ne s’agit pas d’un validateur en temps réel et il ne peut garantir le comportement API ou la validité de la logique métier. Il signale les champs obsolètes, les extensions non prises en charge et les ambiguïtés potentielles. Il prend en charge les fonctionnalités standard de AsyncAPI v2 et les dialectes courants et demeure neutre vis-à-vis de la localisation ; les messages d’erreur peuvent être générés dans la langue configurée.