AsyncAPI Validator

This tool validates AsyncAPI documents to ensure they are well-formed, syntactically correct, and conformant to AsyncAPI v2 specifications. It targets API designers, platform engineers, QA teams, and technical writers who publish or review event-driven contracts, channels, messages, and payload schemas. By accepting YAML or JSON, it checks required sections, structural integrity, and patterns such as servers, channels, messages, and bindings. The validator produces a detailed report with errors, warnings, and remediation guidance.
Core validation logic parses the input with a robust schema parser, resolves references, and enforces conformance rules. It performs syntax validation, schema validation, and cross-field checks (for example, ensuring a channel has at least one operation and that payload schemas are defined). Optional modes enable stricter checks, such as requiring resolvable external refs or enforcing naming conventions and dialect-specific constraints.
Common use cases include validating a draft AsyncAPI document prior to repository submission, auditing an existing spec for completeness and consistency, and producing machine-readable reports for CI pipelines or documentation tooling. The tool is designed for offline or restricted environments where no runtime traffic is exercised. It focuses on design-time quality rather than runtime behavior.
Limitations and scope: the validator examines syntax, structure, and declared schemas only. It is not a runtime validator and cannot guarantee API behavior or business logic validity. It flags deprecated fields, unsupported extensions, and potential ambiguities. It supports standard AsyncAPI v2 features and common dialects, and it remains neutral to localization, error messages can be produced in the configured language.