对象作为Open API Specification Swager上API中的查询字符串参数

Question

我有一个API，它接受查询参数作为对象。我用这个来添加多个过滤器来过滤结果。

当我从 swagger 点击请求时，我在控制器中的过滤器对象为空。

userFilter是POJO类。它被用作查询参数，在控制器中，它是null。

招摇时，显示如下

当试图从userFilter访问任何字段时，userFilter对象未被构造并在控制器类中获取NullPointerException。

Answer 1

我从 swagger.io 那里得到了解决方案。

根据说明，内容用于样式和分解未涵盖的复杂序列化方案。例如，如果我们需要在查询字符串中发送一个 JSON 字符串，如下所示：

filter={"type":"t-shirt","color":"blue"}

在这种情况下，我们需要将< code>parameter模式包装到< code>content/

我们需要将< code > Content = { @ Content(Schema = @ Schema(type = " object "))} 添加到< code>@Parameter中。

@Parameter(description = "Filters", required = true, content = {@Content(schema = @Schema(type = "object"))})

在< code>JSON格式中，它将如下所示。

parameters:
  - in: query
    name: filter
    
    # Wrap 'schema' into 'content.<media-type>'
    content:
      application/json:  # <---- media type indicates how to serialize / deserialize the parameter content
        schema:
          type: object
          properties:
            type:
              type: string
            color:
              type: string