Async API(s) is/are not documented
Description
For newcomers it's not easy to understand the asynchronous API(s) of the backend server(s).
Goal
Documentation of the asynchronous API(s).
Evidence
Solution
Nowadays the AsyncAPI specification is the go to solution for documenting asynchronous APIs.
It's possible to specify the API in a "code-first" manner in a .json or .yml
file. Most adopters seem to use .yml
files cause it has better readability. Refer to here for an websocket protocol spec example or to here for a more advanced one. The AsyncAPI playground is great for interactively editing a file.
Links / references
Work in progress fork is: https://gitlab.com/fkromer/foodsharing/-/tree/1145-asyncapi-spec
Edited by Florian Kromer