Fatal编程技术网
  • ruby-on-rails/
  • Ruby on rails Swagger 2.0中的嵌套查询参数

Ruby on rails Swagger 2.0中的嵌套查询参数

ruby-on-rails swagger

Ruby on rails Swagger 2.0中的嵌套查询参数,ruby-on-rails,swagger,swagger-ui,swagger-2.0,Ruby On Rails,Swagger,Swagger Ui,Swagger 2.0,我正在使用Swagger 2.0编写Rails应用程序的文档，并使用Swagger UI作为人类可读的文档/沙盒解决方案 我有一个资源，客户端可以在其中存储任意元数据以供以后查询。根据Rails约定，查询的提交方式如下： /posts?metadata[thing1]=abc&metadata[thing2]=def 哪些轨道转换为以下参数： { "metadata" => { "thing1" => "abc", "thing2" => "def" } } 它可以

我正在使用Swagger 2.0编写Rails应用程序的文档，并使用Swagger UI作为人类可读的文档/沙盒解决方案

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

/posts?metadata[thing1]=abc&metadata[thing2]=def
哪些轨道转换为以下参数：

{ "metadata" => { "thing1" => "abc", "thing2" => "def" } }
它可以轻松地用于为数据库生成适当的
WHERE
子句

在《大摇大摆》中有人支持这样的东西吗？我希望最终让Swagger UI提供一些方法来修改生成的请求，以便在
元数据
命名空间下添加任意参数。

这似乎还不受支持（在您提出该问题后的2年多时间内），但关于在Web上添加对该问题的支持，仍有一个正在进行的讨论和公开票证。他们将这种嵌套称为
deepObjects

还有一个未解决的问题，即尝试实现。然而，通过使用最新的stable 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
      }
这将显示预期的对话框，并在工作服务器上使用
试用



我认为没有一种好方法可以指定任意值或选择值（例如枚举），因此您可能必须为每个嵌套选项添加参数