Last updated

RabbitMQ-based AsyncAPI docs

  • Topics, queues, exchanges: exchanges do not refer to their queues
  • Message flows: don't have groups with publishers and consumers as in Kafka
  • Schemas and examples: easy to understand, examples are provided
  • Server info: information is clearly defined and accessible from one of the first pages.
  • Operations: it is obvious
  • Navigation: No, we had to go back and forth
  • Missing stuff: We can't see data properties in message schemas

Kafka-based AsyncAPI docs

  • Topics, queues, exchanges: Has more defined topic, clear name, purpose that is related to the analytics data
  • Message flows: message flows are clearly specified, making the data flow understandable.
  • Schemas and examples: easy to understand, examples are provided
  • Server info: information is clearly defined and accessible from one of the first pages.
  • Operations: it is obvious
  • Navigation: yes for sure
  • Missing stuff: seems that is complete

Debrief

What made you smile?

  • We liked the way both documentations are structured & defined.

What did you find confusing?

  • We got puzzled a bit when finding the server information for the RabbitMQ-based AsyncAPI docs, but eventually we found it.