AsyncAPI Validator

Esta ferramenta valida documentos AsyncAPI para garantir que estejam bem formados, sintaticamente corretos e em conformidade com as especificações AsyncAPI v2. Ela atende designers de API, engenheiros de plataforma, equipes de QA e redatores técnicos que publicam ou revisam contratos orientados a eventos, canais, mensagens e esquemas de payload. Aceitando YAML ou JSON, ela verifica seções obrigatórias, integridade estrutural e padrões como servidores, canais, mensagens e bindings. O validador produz um relatório detalhado com erros, avisos e orientações de remediação.
A lógica central de validação analisa a entrada com um analisador de esquema robusto, resolve referências e aplica regras de conformidade. Realiza validação de sintaxe, validação de esquema e verificações entre campos (por exemplo, garantir que um canal tenha pelo menos uma operação e que esquemas de payload estejam definidos). Modos opcionais permitem verificações mais rigorosas, como exigir referências externas resolvíveis ou impor convenções de nomenclatura e restrições de dialeto.
Casos de uso comuns incluem validar um documento AsyncAPI em rascunho antes de enviar ao repositório, auditar uma especificação existente para completude e consistência e gerar relatórios legíveis por máquina para pipelines de CI ou ferramentas de documentação. A ferramenta é projetada para ambientes offline ou restritos onde nenhum tráfego em tempo de execução é exercido. Foca na qualidade de design, não no comportamento em tempo de execução.
Limitações e alcance: o validador examina apenas sintaxe, estrutura e esquemas declarados. Não é um validador em tempo de execução e não pode garantir o comportamento da API ou a validade da lógica de negócios. Ele sinaliza campos obsoletos, extensões não suportadas e ambiguidades potenciais. Suporta recursos padrão do AsyncAPI v2 e dialetos comuns, mantendo neutralidade de localização; mensagens de erro podem ser geradas no idioma configurado.