我想知道以下是否可行。
Swagger 几乎我需要记录基于消息的API。例如对于Command Message我想说“Command”而不是“Post”,而不是“path”我想要命令的名称。
使用“x-”属性可以实现供应商扩展的spec mentions但是我1)没有找到如何执行此操作的任何示例2)不确定使用这些属性是否有助于我满足我的要求目标
任何人都可以指出一些可以帮助我继续前进的资源吗?
答案 0 :(得分:3)
Swagger旨在记录基于 HTTP谓词的 REST API。你不能替换动词或发明新动词。
供应商扩展允许添加规范不允许的其他信息,但最终仍然适用于REST API。
从我收集的内容来看,你试图描述不同的东西。
我们欢迎为Swagger提供额外道路的建议(即,涵盖非REST API),为此,我建议在swagger-spec存储库上打开一个问题。