- Dock API AsyncAPI YAML definition.
- See changelog for changes in the API specification.
- View with AsyncAPI Studio online tool.
The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in the browser.
The AsyncAPI generator tool transforms the API definition into other formats.
The easiest way to generate the HTML documentation from the AsyncAPI definition is to use the official
asyncapi/generator Docker image. You can also try to use the command line
tool with the instructions provided from the generator tool.
The provided Bash wrapper script create-html-docker.sh creates the html documentation in the
./html sub folder.
ℹ️ We will look into using GitHub Pages for publishing the html documentation.