Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<Note. use green for closed issues, yellow for important ones if needed>

AsyncAPI


Parser

The parser is used to validate AsynAPI documents. AsyncAPI documents can be written in either YAML or JSON. There are parsers available for various programming languages including Go, C# and Javascript. For CPS we would leverage the AsyncAPI Parser Java Wrapper.

...

View file
namekafka.yml
height250

...

Code Generators

1. ZenWave SDK

ZenWave 360º is a set of tools built on the foundations of Domain Driven Design and API-First principles for Event-Driven Architectures, to help you create software easy to understand.

...

Zenwave SDK Documentation

2. MultiAPI Generator

In order to get this plugin working, you need the following things installed in your computer:

  • Java 11 Version
  • Maven

MultiAPI Generator Documentation


Documentation Generator

Springwolf

Springwolf is  a project inspired by Springfox for the purpose of documenting Asynchronous APIs. Springwolf covers many different protocols.

Image Added

Springboot listeners are used to generate documentation e.g. @KafkaListener @RabbitListener 

Dependencies used:

Image Added

Resulting documentation:

Image Added