Async Event API Documentation
Document event-driven and asynchronous APIs with channels, operations, messages, protocol bindings for 18 protocols, 13 security schemes, reusable traits, and AsyncAPI 3.0 export in NeoArc Studio.
The async API editor documents event-driven and asynchronous APIs alongside your REST and GraphQL documentation. Define message brokers, channels, operations, messages, and protocol-specific bindings in a structured format that follows the AsyncAPI 3.0 specification and publishes as a browsable async API reference on your documentation site.
Core Concepts
Async API documentation is organised around four resource types that mirror the AsyncAPI 3.0 specification:
Protocol Support
18 protocols across six categories:
Security
13 security scheme types designed for broker and event-driven authentication:
Reusable Traits
Define cross-cutting properties once and apply them to multiple messages or operations:
All 18 Protocols
Each protocol has dedicated binding configuration in both the editor and the published viewer.
Schema Integration
Viewer
The published site includes an async API browser that presents all documented event-driven APIs.
AsyncAPI 3.0 Export
Export your async API documentation to the standard AsyncAPI 3.0 format for use with other tools in the AsyncAPI ecosystem. Import existing AsyncAPI specifications to get started quickly.
Use Cases
Document REST APIs with full endpoint specifications, OpenAPI import and export, seven HTTP methods, parameters, request and response bodies linked to shared schemas, authentication schemes, and a published API browser. REST is one of six API types (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.
Document GraphQL APIs with queries, mutations, subscriptions, custom scalars, directives, interfaces, and per-operation authentication in NeoArc Studio.
Document webhook-based integrations with event definitions, HMAC signature verification, delivery guarantees, retry policies, dead letter queues, circuit breakers, and consumer guidance. The structured webhook editor captures what architects need to express about push-based event notifications.
Define data structures with ten field types, 65+ type specialisations, and 50+ validation rules. Create reusable schemas that stay synchronised across your documentation.