如何在Swagger中使用短划线分隔路径参数

Question

我正在尝试在现有API上使用Yaml创建Swagger文档。 在这个API中有一个这样的路径：

/api/foo--bar/baz

所以我在Swagger编辑器中创建了这样的路径定义：

paths:
  /api/{foo}--{bar}/{baz}:
    get:
      parameters:
        - $ref: '#/parameters/foo'
        - $ref: '#/parameters/bar'
        - $ref: '#/parameters/baz'
[...]

现在我被编辑告诉我：

  

paths./api/{foo}--{bar}/{baz}中的语义错误   不允许部分路径模板化。

是否有可能在招摇中表达如上所述的url路径？

Answer 1

您的语法是正确的。您在Swagger Editor 3.0-3.1.5中看到的错误是 was a bug。您可以忽略该错误，或​​使用http://editor2.swagger.io处没有此错误的旧Swagger Editor 2.x。

更新：此错误已在Swagger Editor 3.1.6和在线编辑器http://editor.swagger.io中修复。