消息传递API的Swagger UI

Question

我想知道以下是否可能。

Swagger是差不多我需要文档基于消息的API。例如，对于Command Message，我想说“命令”而不是“发布”，而不是“路径”，我希望命令的名称。

spec mentions供应商扩展可能使用“x-”属性，但我1）找不到如何做到这一点的任何示例和2）不确定使用这些属性是否会帮助我实现我的目标。

任何人都可以指向我一些资源，可以帮助我移动？

Answer 1

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

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

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

我们欢迎Swagger提供额外道路的建议（即覆盖非REST API），为此，我建议在swagger-spec存储库上打开一个问题。