Channels and Operations
Define channels (topics, queues, subjects) and operations (send/receive) for async event APIs. Configure addresses with parameters, protocol bindings, and request-reply patterns.
Channels and operations are the core building blocks of async API documentation. A channel represents a message destination (topic, queue, or subject) while an operation describes how your application interacts with that channel.
Channels
A channel represents a destination where messages are sent and received. Depending on the protocol, this maps to a Kafka topic, AMQP exchange/queue, MQTT topic, or other protocol-specific concept.
Address Parameters
When you include {parameter} expressions in a channel address, NeoArc automatically detects and creates parameter entries. Each parameter can have a description, enum values, and examples.
Example: Order Events Channel
Operations
An operation describes how your application interacts with a channel. The two actions are send (your application publishes messages) and receive (your application subscribes to messages).
Send vs Receive
Example: Send Operation
Example: Receive Operation
Request-Reply Pattern
Operations can define a reply configuration for request-reply messaging patterns. Specify a reply channel, reply messages, and an address location expression for dynamic reply destinations.
Operation Traits
Operation traits capture reusable cross-cutting properties that apply to multiple operations. Common use cases include shared security requirements, standard bindings, and tagging conventions. Traits are defined in the API definition and referenced by operations.