AsyncAPI Payload Validator
A Python tool for validating JSON message payloads against AsyncAPI specifications. Performs detailed JSON Schema validation including type checking, constraints, patterns, enums, and composition rules.
- Comprehensive validation - types, required fields, string length, patterns, enums, numeric constraints, oneOf/anyOf/allOf
- Lenient type coercion - string numbers and booleans accepted where appropriate
- AsyncAPI 2.x and 3.x - supports both specification versions
- HTML reports - detailed reports with line-by-line source highlighting
- Jinja2 templates - validate template structure before rendering
- CI/CD ready - exit codes, GitHub Actions and GitLab CI examples
pip install asyncapi-payload-validator
Install from source
git clone https://github.com/ingka-group/asyncapi-payload-validator.git
cd asyncapi-payload-validator
pip install .
For development: pip install -e ".[dev]"
# Basic validation
asyncapi-validate payload.json asyncapi-spec.yaml
# Generate HTML report
asyncapi-validate payload.json asyncapi-spec.yaml --html-report report.html
# Validate specific message by ID
asyncapi-validate payload.json asyncapi-spec.yaml --message-id UserSignedUp
# Validate Jinja2 template structure
asyncapi-validate template.json spec.yaml --render-jinja2
# Validate rendered template with context
asyncapi-validate template.json spec.yaml --render-jinja2 --jinja2-context context.json
import json, yaml
from pathlib import Path
from asyncapi_payload_validator import validate_payload
payload = json.loads(Path('payload.json').read_text())
spec = yaml.safe_load(Path('asyncapi.yaml').read_text())
result = validate_payload(payload, spec)
if result['valid']:
print("Validation passed!")
else:
print(f"{result['summary']['total_violations']} violation(s)")
for category, violations in result['violations'].items():
for v in violations:
print(f" - {v}")
See Python API Reference for the full API, return value structure, and advanced usage.
Icon
Category
Description
| ➕ |
Extra Attributes |
Fields in payload not declared in schema |
| ❌ |
Type Mismatches |
Incorrect data types (with lenient coercion) |
| 🚫 |
Missing Required |
Required fields absent from payload |
| ↔️ |
Length Violations |
String minLength/maxLength constraints |
| #️⃣ |
Pattern Violations |
Regex pattern mismatches |
| ✅ |
Enum Violations |
Values not in allowed enum list |
| 🔢 |
Numeric Violations |
min/max/multipleOf constraints |
| 🧩 |
Composition Violations |
oneOf/anyOf/allOf rule failures |
Code
Meaning
| 0 |
Validation passed |
| 1 |
Validation failed (violations found) |
| 2 |
Error (invalid arguments, file not found) |
| 130 |
Cancelled by user (Ctrl+C) |
Contributions are welcome! See CONTRIBUTING.md for guidelines.
MIT - see LICENCE.md for details.