Architecture 记录事件驱动的体系结构

Architecture 记录事件驱动的体系结构,architecture,documentation,event-driven-design,Architecture,Documentation,Event Driven Design,我正在设计一个事件驱动系统,由至少两个团队与两个不同的外包公司共同构建 我们已经在内部设计了一切,但现在我正在为开发团队创建文档 对于我正在使用的HTTP 是否有任何工具或语言来描述事件和处理流 创建此类文档的最佳做法是什么?以下是一种方法: 定义系统接受的事件的最终列表。例如,事件可以基于,并记录在JSONSchema中(根据) 对于每个系统组件,定义组件产生和使用的事件(在上述列表中) 对于特别复杂的单个事件流,请在序列图中写出它们 这是另一个有趣(且更全面)的方法。这有点像Swagger/

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

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

对于我正在使用的HTTP

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

创建此类文档的最佳做法是什么?

以下是一种方法:

  • 定义系统接受的事件的最终列表。例如,事件可以基于,并记录在JSONSchema中(根据)
  • 对于每个系统组件,定义组件产生和使用的事件(在上述列表中)
  • 对于特别复杂的单个事件流,请在序列图中写出它们
  • 这是另一个有趣(且更全面)的方法。这有点像Swagger/OpenAPI,但对于事件驱动系统:您定义的不是路径和HTTP操作,而是消息传递通道和订阅/发布操作


    回答有点晚,我很想知道你最终是如何解决这个问题的

    两个伟大的工具!这些是我一直在寻找的工具。当时我们没有解决这个问题,所有的通信和事件都是使用wiki页面记录的。