Async Event APIs
Document event-driven and asynchronous APIs with channels, operations, messages, protocol bindings, and security schemes. Content Foundry includes a complete AsyncAPI 3.0 documentation workflow for a range of protocols including Kafka, AMQP, MQTT, WebSocket and others.
A dedicated editor supports documenting event-driven and asynchronous APIs following the AsyncAPI 3.0 specification. Define message brokers, channels, operations, messages, and protocol-specific bindings in a structured format that publishes as a browsable async API reference alongside your REST and GraphQL documentation.
Example APIs
Explore this complete working example that demonstrates async event API documentation with Kafka protocol bindings, message traits, correlation IDs, and schema integration.
E-Commerce Events API: Order Events
The order events channel carries all order lifecycle events, partitioned by orderId for ordered delivery.
E-Commerce Events API: Payment Processing
The payment status channel carries payment outcome events from the payment gateway.
E-Commerce Events API: Inventory Updates
The inventory updates channel publishes stock level changes using Kafka log compaction for latest-state semantics.
Supported Protocols
NeoArc supports a range of protocols across six categories, including MQTT, AMQP, Kafka, WebSocket and others.
| Category | Protocols |
|---|---|
| Streaming | Apache Kafka, Apache Pulsar |
| Messaging | AMQP 0-9-1, AMQP 1.0, NATS, JMS, STOMP, Redis Pub/Sub |
| Web | HTTP, WebSocket, Mercure |
| IoT | MQTT, MQTT 5.0 |
| Cloud | Amazon SNS, Amazon SQS, Google Pub/Sub |
| Enterprise | IBM MQ, Solace PubSub+ |
Security Schemes
Security scheme types covering HTTP, broker, certificate, encryption, and SASL categories.
| Category | Schemes | Use Case |
|---|---|---|
| HTTP | Bearer, Basic, Digest, API Key | REST-style API gateways and management APIs |
| Broker | User/Password, API Key (user/password) | Direct broker authentication |
| Certificate | X.509, Mutual TLS | Certificate-based mTLS connections |
| Encryption | Symmetric, Asymmetric | Message-level encryption |
| SASL | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, GSSAPI (Kerberos) | Kafka and enterprise broker authentication |
| Federated | OAuth2, OpenID Connect | Token-based authentication with scopes |