是否可以使用整个原始字符串作为参数

时间:2018-11-09 21:28:37

标签: swagger swagger-ui swagger-2.0

有一个类似的网址 http://someservice.com/confirm?{token}

这是如何用摇号来描述该端点

如果用作查询参数,则得到

  /confirm:
    get:
      summary: ...
      parameters:
        - in: query
          name: token
        ...

http://someservice.com/confirm?token=value不好

从另一面看,无法按照以下方式使用网址符号:

  /confirm?{token}:
    get:
      summary: ...
      parameters:
        - in: path
          name: token
        ...

由于路径中的查询字符串而被禁止。

1 个答案:

答案 0 :(得分:1)

OpenAPI 2.0和OpenAPI 3.0当前均不支持此功能。这是相应的功能请求:

Support for arbitrary query strings