AsyncAPI和RESTful API之间的共享模型？

Question

我试图解决的问题：

• 假设我运行了一组微服务，其中大多数服务公开了RESTful API，并通过消息代理发布或使用事件，
• 我决定先使用OpenAPI和AsyncAPI来指定这些API，
• 当我设计域模型时，
• 然后..。我应该为REST和messagin创建单独的域模型，还是应该在事件中重用REST规范中的模型？

我自己想出的

利弊：

专业：

• 如果模型的表示在REST和消息传递中是相同的，客户端将更快地理解它。
• 我只需要写一次规范。
• REST和消息传递没有重复的模型定义，因此它们不能意外地偏离彼此。
• 我不需要使用AsyncAPI生成器，因为所有模型类都是由OpenAPI生成器生成的。

Con：

• AsyncAPI允许$reference OpenAPI模型，因为两者都是基于JSON模式的，但不能保证AsyncAPI中的每个OpenAPI特性都能得到支持。

AsyncAPI还很年轻，所以.：是否已经有了一个通用的最佳实践？

Answer 1

报告到目前为止我们自己的经验:我们已经决定分享DTO模型，也是基于@Robert的评论，这种重用对我们来说效果很好。AsyncAPI文件总是引用OpenAPI模型。我们只使用Openapi生成器。到目前为止，我们还没有遇到任何语法问题。

也许这有助于其他面对相同API设计决策的读者。