I'm designing an Event-Driven system to be built by at least two teams with two different outsourcing companies.
We have designed everything internally, but now I'm creating the documentation for the development team.
For the HTTP I'm using OpenAPI.
Is there any tool or language to describe Events and Streams of processing?
What are the good practices for creating this kind of documentation?
Here's one approach:
The AsyncAPI spec is another interesting (and more all-encompassing) approach. It's a bit like Swagger/OpenAPI but for event-driven systems: instead of paths and HTTP operations you define messaging channels and subscribe/publish operations.
Bit of a late answer, I'd be curious to hear how you ended up solving the problem!
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With