Swagger UI：post请求正文中的对象数组忽略explode=true

Question

我试图使用Swagger来记录一个API POST调用，它有一个对象数组参数。但是当我试图在Swagger UI中测试它时，似乎explode:true在encoding:filters中被忽略了。这是我的代码：

openapi: 3.0.2
info:
  description: >-
    My API
  version: 1.0.0
  title: My API
tags:
  - name: myApi
    description: my API
paths:
  /myApi/getList:
    post:
      tags:
        - myApi
      summary: gets a list
      description: gets a list
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                sourceId:
                  type: integer
                  description: the source id
               filters:
                  type: array
                  items:
                    $ref: '#/components/schemas/Filter'
            encoding:
              filters:
                contentType: application/json
                explode: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '500':
          description: error
components:
  schemas:
    Filter: 
      type: object
      properties:
        field:
          type: string
          description: the name of the field for this filter
        selection:
          type: array
          items:
            type: string
            description: the name of a selected value of the filter field
      required: [attribUniqueName, selection]

sourceId: 1

filters: [
  {
    "field": "product",
    "selection": ["Prod A", "Prod B"]
  },
  {
    "field": "country",
    "selection": ["USA", "France"]
  }
]

sourceId=1&filters={"field":"product","selection":["Prod A","Prod B"]},{"field":"country","selection":["USA","France"]}

sourceId=1&filters={"field":"product","selection":["Prod A","Prod B"]}&filters={"field":"country","selection":["USA","France"]}

反而？

OpenAPI 3.0.2“Encoding Object”文档指出，如果请求体媒体类型不是application/x-www-form-urlencoded，则“忽略explode属性”。但是我们在这里使用的是application/x-www-form-urlencoded。或者文档是不是错误的，它应该声明“内容类型当前对象”而不是“请求体媒体类型”？但是，我会假设得到一个真实的数组作为参数值，I。E.

sourceId=1&filters=[{"field":"product","selection":["Prod A","Prod B"]},{"field":"country","selection":["USA","France"]}]

如果有关系的话：我使用的是Swagger UI3.24.3版本。

Answer 1

您的代码看起来不错，实际问题是Swagger UI还不支持编码。

有关GitHub的相关问题请参见此处。它有一个字符串数组的例子，而不是像您的例子中的对象数组，但可能只要它对字符串不起作用，它对对象也不起作用。