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>

Any Other Header

AsyncAPI

Image Added

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.


Template

A template is a project that specifies the generation process output by using the AsyncAPI generator and an AsyncAPI document. These files describe the generation results depending on the AsyncAPI document's content. Relevant outputs include Code and Documentation.

A template is an independent Node.js project unrelated to the generator repository. There are Java, Java Spring and Java Spring Cloud Stream templates. Templates.


Generator

The AsyncAPI generator is a tool that generates anything you want using the AsyncAPI Document and Template that are supplied as inputs to the AsyncAPI CLI. The template can define code, documentation and diagrams among other things to be generated with the generator.


Example AsyncAPI Document

View file
namekafka.yml
height250
< we do not want to dictate the remainder of an analysis it will depend on the type of user story at hand>

Any Other Header

Etc