如何在 swagger UI 中输入嵌套数组的数据

Question

我正在使用asp构建一个web api。netwebapi 2，对于我的文档，我选择了swagger。

我遇到的问题是我的一个api方法采用嵌套数组（另一个数组中的字符串数组）。在postman中手动测试时，当我键入以下内容时效果很好：

http:/localhost:port/setup?array[0]=key1&array[0]=value1&array[1]=key2&array[1]=value2

但是在swagger-ui中，我只输入一个字段，每行只有一个参数。这使得我不能为每个嵌套数组输入两个值。

结果应如下所示 （json）：

[["key1","value1"],["key2","value2"]]

这是我通过上面的查询参数实现的。虽然我只能在swagger ui文本字段中实现以下功能：

[["key1"],["value1"],["key2"],["value2"]]

为了一个answare，我已经在互联网上打扫了1-2个小时，但是只能找到询问如何在yaml文件中定义嵌套数组的帖子。我在swagger github上读到的一些差事让我认为这根本不可能。虽然这不是一个关键特性，但如果所有的测试都能正常工作，那就太好了。

所以问题是，如果可能的话，我如何在swagger-ui中的嵌套数组中键入两个单独的字符串。

我在这些方面都不是专家。我学会了如何使用json api和swagger，所有这些都是本周的事情，所以请在回顾这篇文章时记住这一点。

先谢谢！

Answer 1

嵌套数组很简单：

type: array
items:
  type: array
  items: 
    type: string

但是OpenAPI/Swagger无法像您的示例那样序列化查询字符串中的嵌套数组。

如果数组有固定数量的项，可能的解决方法是将每个嵌套数组定义为一个单独的查询参数:

paths:
  /setup:
    get:
      parameters:
        - in: query
          name: array[0]
          required: true
          type: array
          items:
            type: string
          collectionFormat: multi   # array[0]=key1&array[0]=value1
        - in: query
          name: array[1]
          required: true
          type: array
          items:
            type: string
          collectionFormat: multi   # array[1]=key2&array[1]=value2

更好的方法是使用 POST 请求并在请求正文中传递数组：

paths:
  /setup:
    post:
      consumes:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            type: array
            items:
              type: array
              items: 
                type: string