在扬鞭2.0嵌套查询参数

问题描述 投票:2回答:1

我记录一个Rails应用程序与扬鞭2.0和使用扬鞭的UI作为人类可读文档/沙箱溶液。

我有一个资源,在这里客户可以存储以后查询任意元数据。根据Rails的约定,查询将提交如下所示:

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

这Rails的转换到PARAMS:

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

这可以很容易地被用于产生对于数据库的适当WHERE子句。

是否有在扬鞭这样的技术支持吗?我想最终还是扬鞭的UI提供一些方法来修改生成的请求metadata命名空间下对任意PARAMS补充。

ruby-on-rails swagger swagger-ui swagger-2.0
1个回答
0
投票

这似乎不是被支持(你问的问题超过2年后),但有一个持续的讨论和公开售票有关的OpenAPI github repo提供这方面的支持。他们称这种类型的嵌套的deepObjects

还有另外一个地方的执行试图here悬而未决的问题。使用最新的稳定招摇的UI版本,但是,我观察到它的工作如我所料:

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

这带来预期的对话框和与对工作服务器Try it out工作。

enter image description here

我不相信这是指定的任意或选择值(例如枚举)的好方法,所以你可能需要添加参数,每一个嵌套选项。

© www.soinside.com 2019 - 2024. All rights reserved.