用于消息传递的 Swagger UI API

Swagger UI for messaging API

我想知道以下是否可行。

Swagger 几乎 是我记录基于 API 的消息所需要的。例如对于 Command Message 我想说 "Command" 而不是 "Post",而不是 "path" 我想要命令的名称。

spec mentions 可以使用 "x-" 属性进行供应商扩展,但我 1) 没有找到任何如何执行此操作的示例,以及 2) 不确定使用这些属性是否有帮助我实现了我的目标。

谁能给我指点一些可以帮助我前进的资源?

Swagger 旨在记录基于 HTTP 动词 REST API。您不能替换动词或发明新动词。

供应商扩展允许添加规范不允许的额外信息,但最终,它仍然适用于 REST API。

根据我收集到的信息,您试图描述一些不同的东西。

我们欢迎为 Swagger 的其他道路(即涵盖非 REST API)提出建议,为了做到这一点,我建议在 swagger-spec 存储库上打开一个问题。