Swagger 2.0中的嵌套查询参数

Question

我正在用Swagger 2.0记录一个Rails应用程序，并使用Swagger-UI作为人类可读的文档/沙盒解决方案。

我有一个资源，客户端可以在其中存储任意元数据以供以后查询。根据 Rails 约定，查询将按如下方式提交：

/posts?metadata[thing1]=abc&metadata[thing2]=def

Rails将其转换为以下参数：

{ "metadata" => { "thing1" => "abc", "thing2" => "def" } }

它可以很容易地用于为数据库生成适当的 WHERE 子句。

Swagger里有支持这种东西的吗？我想最终让Swagger-UI提供一些方法来修改生成的请求，以便在< code>metadata名称空间下添加任意参数。

Answer 1

这似乎还没有得到支持（在你问这个问题两年多后），但正在进行讨论

这里尝试实现了另一个未解决的问题。然而，使用最新稳定的swagger-ui版本，我观察到它如我所料地工作:

    "parameters": [
      {
        "name": "page[number]",
        "in": "query",
        "type": "integer",
        "default": 1,
        "required": false
      },
      {
        "name": "page[size]",
        "in": "query",
        "type": "integer",
        "default": 25,
        "required": false
      }

这将显示预期的对话框

我不认为有一个好的方法来指定任意值或值的选择(例如枚举)，所以您可能必须为每个嵌套选项添加参数。