消息API的Swagger UI

Question

我想知道以下是否可行。

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

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

有人能给我指出一些可以帮助我前进的资源吗？

Answer 1

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

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

据我所知，你想描述一些不同的东西。

我们欢迎为Swagger提供更多途径的建议（即，涵盖非RESTAPI），为了做到这一点，我建议在Swagger规范存储库上打开一个问题。