记录事件驱动的体系结构

Question

我设计的事件驱动系统至少由两个团队和两个不同的外包公司共同建立。

我们已在内部设计了所有内容，但现在我正在为开发团队创建文档。

对于HTTP我使用RAML。

是否有任何工具或语言来描述处理事件和流？

创建此类文档的良好做法是什么？

Answer 1

这是一种方法：

1. 定义系统接受的事件的确定列表。例如，事件可以基于CloudEvents spec，并以JSONSchema记录（根据this answer）。
2. 对于每个系统组件，定义该组件产生和消耗的事件（在上述列表中）。
3. 对于特别多毛的单个事件流，请在顺序图中将其写出。

AsyncAPI spec是另一种有趣的（并且更是包罗万象的）方法。它有点像Swagger / OpenAPI，但对于事件驱动的系统：您可以定义消息传递通道和订阅/发布操作，而不是路径和HTTP操作。

一个较晚的答案，我很想知道您最终如何解决这个问题！