Apache
/
activemq-artemis
mirror of https://github.com/apache/activemq-artemis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NO-JIRA update REST doc with caveats

This commit is contained in:
Justin Bertram 2021-07-20 15:10:41 -05:00
parent 4883285a2a
commit eefb748552
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/user-manual/en/rest.md
View File

@ -3,7 +3,7 @@
The Apache ActiveMQ Artemis REST interface allows you to leverage the reliability and The Apache ActiveMQ Artemis REST interface allows you to leverage the reliability and
scalability features of Apache ActiveMQ Artemis over a simple REST/HTTP interface. scalability features of Apache ActiveMQ Artemis over a simple REST/HTTP interface.
The REST Interface implementation sits on top of an Apache ActiveMQ Artemis JMS API and The REST Interface implementation sits on top of an Apache ActiveMQ Artemis JMS API and
as such exposes JMS like concepts via REST. as such exposes JMS-like concepts via REST.
Using the REST interface Messages can be produced and consumed by sending Using the REST interface Messages can be produced and consumed by sending
and receiving simple HTTP messages that contain the content you want to push around. For instance, and receiving simple HTTP messages that contain the content you want to push around. For instance,
@ -28,6 +28,25 @@ as a JMS message and distributed through core Apache ActiveMQ Artemis. Simple an
Consuming messages from a queue or topic looks very similar. We'll Consuming messages from a queue or topic looks very similar. We'll
discuss the entire interface in detail later. discuss the entire interface in detail later.
## Caveats of Using the REST Interface
Before adopting the REST interface it's important to recognize the potential trade-offs.
* **There is no standard for REST messaging.** Any application which integrates with the
ActiveMQ Artemis REST messaging interface cannot then integrate with any other broker's
REST messaging interface without significant effort because every REST messaging
interface is different. Even the ActiveMQ Classic broker has its own REST messaging
interface which is different from Artemis'.
* **For most use-cases STOMP is better.** In just about any environment where a simple
HTTP client might be advantageous for messaging there usually also exists a STOMP client
implementation. STOMP is ubiquitous and *standardized* (i.e. it conforms to a public
specification) which means it can be used across various broker implementations with
few, if any, client changes.
Messaging is almost always leveraged for _integrating_ disparate applications. Protocol
flexibility and interoperability are vital to such solutions. Consider these caveats
carefully before committing to a solution.
## Goals of REST Interface ## Goals of REST Interface
Why would you want to use Apache ActiveMQ Artemis's REST interface? What are the goals Why would you want to use Apache ActiveMQ Artemis's REST interface? What are the goals