在OpenApi 3中展平RequestParam对象

Question

我正在从swagger 2迁移到OpenApi 3。

Swagger 2示例代码

    @ApiOperation(value = "", nickname = "")
        @GetMapping
          public List<Employee> findEmployees(@Valid Dto dto) {
                return employeeService.findEmployees(dto);
                }

OpenApi 3代码

    @Operation(summary = "")
        @GetMapping
          public List<Employee> findEmployees(@Valid Dto dto) {
                return employeeService.findEmployees(dto);
                }

DTO类

    @Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public class Dto {
        private String status;
        private String name;
        private String destination;
    }

在这两种情况下，大摇大摆的用户界面的生成有显著差异。

Swagger 2将DTO对象展平为单个查询参数：

在Swagger 2用户界面中，对象作为单个查询参数进行图像展平

OpenApi 3创建JSON对象时：

图像对象不会展平，而是创建一个json对象

我想让OpenApi 3中的扁平化行为像以前在Swagger 2中一样。在OpenAPI3中有没有办法实现同样的功能。

Answer 1

经过一些研究，我发现openapiui依赖的新版本已经在2020年4月12日发布，它解决了我手头的问题。

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.3.2</version>
</dependency>

在查询参数对象解决它之前使用注解@ParameterObject。

   @Operation(summary = "")
        @GetMapping
          public List<Employee> findEmployees(**@ParameterObject** @Valid Dto dto) {
                return employeeService.findEmployees(dto);
                }