asyncapi / asyncapi/studio

Template Request: RabbitMQ (AMQP)

Open
#1,253 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
213
Forks
143
Avg merge
13h 57m
Merged PRs (30d)
11

Description

#### Reason/Context
Please try answering few of those questions
- Why we need this improvement?
Because RabbitMQ is a widely used me message broker and many teams use it

- How will this change help?
RabbitMQ (AMQP) is not underrepresenated in the AsyncApi project

- What is the motivation?
Right now the documentation lacks information for AMQP and therefore this would help AMQP users to start with AsyncApi.
AMQP is a more advanced use case, because we have exchanges and queues bound to these exchanges via routing key / headers.
Documenting this isn't always clear and an template would make it easier for starting with it.

#### Description
Please try answering few of those questions
- What changes have to be introduced?
Add template with basic AMQP docu

- Will this be a breaking change?
No

- How could it be implemented/designed?
Example with one send and one receive operation, with topic exchange, queue and routing key binding.
Maybe add an additional example for header exchanges and a header binding.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing protocol templates and their example structure in the repository, then compare how send and receive operations and bindings are represented. Done means an AMQP template documents one send and one receive operation with a topic exchange, queue, and routing-key binding, with an optional header-exchange example.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.