通过UI将数组传递给Swagger块参数

Question

是否可以使用UI将项目数组传递到swagger块中的单个参数中？我在ruby\rails应用程序中使用它。请求类型是GET。

我有一个接受许多参数的搜索 API。所有这些都是单一值，但一个设施除外。它接受一个项目数组，并且可以使用类似于下面显示的 URL 进行调用（下面的示例显示了传递的两个值 1 和 2）。

http://localhost:3000/api/venues/search.json?facilities%5B%5D=1&facilities%5B%5D=2

我的参数是这样设置的:

# INDEX (API)
swagger_path '/venues.json' do
  operation :get do
    parameter do
      key :name, :facilities
      key :in, :query
      key :description, 'Facilities.  This does not work.'
      key :type, :array
      key :required, false
    end
  end
end

当我在swagger中传递数组作为参数时，EG[1]会生成以下URL来调用API：

http://localhost:3000/api/venues/search?facilities=%5B1%5D

Swagger似乎把“[1]”翻译成了URI“[1]”，并把它作为参数的值，这是我希望它做的。我希望，因为我将它设置为一种“数组”类型，它知道每次为数组的每个元素设置参数名为“facilities[]”。

我想我遗漏了数组的一些定义，但找不到任何关于招摇块的文档。

我看过一篇帖子，有人传递了一个逗号分隔的字符串，然后让API创建一个数组来解决这个问题。

我所有的单值参数请求都按预期工作。

感谢任何帮助或建议。提前感谢。

Answer 1

Swagger UI是对您放入其中的值进行URL编码的，因为使用了一些不支持的字符(“[”和“]”)。当url中的字符被评估为不是URL中的本地字符时，它将被编码并发送到web服务器，web服务器通常会对其进行解码并将其传递给您正在使用的任何管道。有效字符的列表可以在这里找到。

似乎您正在尝试重现帖子正文如何处理数组。由于 url 编码问题，这可能会导致一些问题。您是否尝试过执行以下操作来指定数组？

• 示例：GET/products？项目=1

一些web服务器和管道将其视为一个数组，当您试图访问“项目”时，它会返回1、2、3和4。