使用什么工具来记录事件模式

What tools to use on documenting event schema

我们的团队开始实施事件驱动设计。我们现在正在研究记录这些事件的模式的最佳 tool/s 和实践。

此用例使用的常用工具是什么?

欢迎提供任何链接或建议。

我将从常见的 CloudEvents spec and model my events based on that, i.e., define the events as subtypes of the generic CloudEvent model. The benefit here is interoperability with other systems based on the same spec as well as the existing tooling such as language SDKs 开始。

至于文档,我会选择 JSONSchema:here's 例如通用 CloudEvent 的 JSONSchema 定义。

作为替代方案,AsyncAPI specification which you can use instead of or together with CloudEvents: read here 说明了两者之间的关系。