architecture - 记录事件驱动的架构

Question

我正在设计一个事件驱动系统，由至少两个团队与两个不同的外包公司构建。

我们在内部设计了一切，但现在我正在为开发团队创建文档。

对于我使用的 HTTP OpenAPI .

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

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

Answer 1

这是一种方法:

定义系统接受的事件的明确列表。这些事件可能基于 CloudEvents spec ，例如，并记录在 JSONSchema 中(根据 this answer)。

对于每个系统组件，定义组件生成和使用哪些事件(在上述列表之外)。

对于特别多毛的单个事件流，将它们写在序列图中。

AsyncAPI spec是另一种有趣(而且更全面)的方法。它有点像 Swagger/OpenAPI，但适用于事件驱动系统:您定义消息 channel 和订阅/发布操作，而不是路径和 HTTP 操作。

回答有点晚，我很想知道您最终是如何解决问题的!