STOMP DEFINITION SOFTWARE

Servers MAY support many channel instances, allowing messages with different content to be addressed to different channels. Producer applications send messages to channels and consumer applications consume messages from channels. ChannelĪ channel is an addressable component, made available by the server, for the organization of messages. Since a message is a generic mechanism, it can support multiple interaction patterns such as event, command, request, or response. The payload contains the data, defined by the application, which MUST be serialized into a format (JSON, XML, Avro, binary, etc.). The headers MAY be subdivided into protocol-defined headers and header properties defined by the application which can act as supporting metadata. A message MUST contain a payload and MAY also contain headers.

MessageĪ message is the mechanism by which information is exchanged via a channel between servers and applications. A consumer MAY be consuming from multiple channels depending on the server, protocol, and the use-case pattern. ConsumerĪ consumer is a type of application, connected to a server via a supported protocol, that is consuming messages from channels. A producer MAY be publishing to multiple channels depending on the server, protocol, and use-case pattern. ProducerĪ producer is a type of application, connected to a server, that is creating messages and addressing them to channels. An application MUST also use a protocol supported by the server in order to connect and exchange messages. An application MAY be written in any number of different programming languages as long as they support the selected protocol. An application MAY be a microservice, IoT device (sensor), mainframe process, etc. It MUST be a producer, a consumer or both. Definitions ApplicationĪn application is any kind of computer program or a group of them. However, AsyncAPI offers a mechanism called 'bindings' that aims to help with more specific information about the protocol and/or the topology.

Therefore, a server MAY be a message broker, a web server or any other kind of computer program capable of sending and/or receiving data.

STOMP DEFINITION SOFTWARE

The AsyncAPI specification does not assume any kind of software topology, architecture or pattern. It means that the application allows consumers to subscribe to the user/signedup channel to receive userSignUp messages. User/signedup: subscribe: $ref: '#/components/messages/userSignUp' For instance, consider the following AsyncAPI definition snippet: The file(s) MUST describe the operations an application accepts. These files can then be used to create utilities, such as documentation, integration and/or testing tools. The AsyncAPI Specification defines a set of files required to describe such an API. It’s protocol-agnostic, so you can use it for APIs that work over any protocol (e.g., AMQP, MQTT, WebSockets, Kafka, STOMP, HTTP, etc). The AsyncAPI Specification is a project used to describe and document message-driven APIs in a machine-readable format. The AsyncAPI Specification is licensed under The Apache License, Version 2.0. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in RFC 2119. Mainly because it's a great work and we want to keep as much compatibility as possible with the OpenAPI Specification. Part of this content has been taken from the great work done by the folks at the OpenAPI Initiative. Found an error? Have a suggestion? Edit this page on Github AsyncAPI Specification Disclaimer

Stomp definition