logo标签列表

记录事件驱动架构

architecturedocumentationevent-driven-design
21

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

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

对于HTTP，我正在使用OpenAPI。

有没有工具或语言可以描述事件和处理流程？

创建这种类型文档的最佳实践是什么？

1个回答
9
这里有一种方法：
  1. 定义系统接受的事件的明确列表。例如，可以基于CloudEvents规范，并在JSONSchema中记录（如this answer所述）。
  2. 对于每个系统组件，定义其生产和消费的事件（来自上述列表）。
  3. 对于特别复杂的单个事件流，请将它们写成顺序图。
AsyncAPI规范是另一种有趣（且更全面）的方法。它有点像Swagger/OpenAPI，但针对事件驱动系统：您定义消息通道和订阅/发布操作，而不是路径和HTTP操作。
有点晚了，我很想知道您最终是如何解决问题的！
1
两个很棒的工具！这就是我一直在寻找的工具。当时我们没有解决问题，所有的沟通和事件都是使用维基页面进行记录的。 - Victor
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接