AsyncAPI — OpenAPI pro event-driven architektury

OpenAPI pro REST, ale co pro Kafka topics a event-driven komunikaci? AsyncAPI vyplňuje tuto mezeru — standardní specifikace pro asynchronní API.

Problém: nedokumentované eventy¶

Po roce event-driven architektury máme 40 Kafka topiců. Kdo do nich píše? Jaký je formát zprávy? Co znamená field „status”? Tribal knowledge — a nový vývojář je ztracený.

AsyncAPI specifikace¶

YAML soubor popisující channels (topicy), message schémata, server info a security. Auto-generovaná dokumentace, JSON Schema validace, a code generation pro producery i consumery.

Schema Registry + AsyncAPI¶

Confluent Schema Registry vynucuje Avro schémata. AsyncAPI specifikace odkazuje na tyto schémata. Výsledek: evoluce schémat je řízená, breaking changes jsou detekované v CI.

Dokumentujte své eventy¶

AsyncAPI je pro event-driven to, co OpenAPI pro REST. Contract-first přístup funguje i pro asynchronní komunikaci.