swagger - 用于消息传递 API 的 Swagger UI

Question

我想知道以下是否可行。

Swagger几乎是我记录基于消息的 API 所需要的。例如对于命令消息，我想说“命令”而不是“发布”，而不是“路径”，我想使用命令的名称。

规范提到供应商扩展可以使用“ x-”属性，但我 1）没有找到任何如何做到这一点的例子，2）不确定使用这些属性是否有助于我实现目标。

任何人都可以向我指出一些可以帮助我继续前进的资源吗？

Answer 1

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

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

从我收集到的信息来看，你试图描述一些不同的东西。

我们确实欢迎为 Swagger 提供其他途径的建议（即涵盖非 REST API），为了做到这一点，我建议在 swagger-spec 存储库上打开一个问题。