小编Sum*_*mit的帖子

在 OpenApi 3 中展平 RequestParam 对象

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

Swagger 2 示例代码


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

Run Code Online (Sandbox Code Playgroud)

OpenApi 3 代码


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

Run Code Online (Sandbox Code Playgroud)

DTO类


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

Run Code Online (Sandbox Code Playgroud)

在这两种情况下,swagger-ui 的生成存在显着差异。

Swagger 2 将 DTO 对象显示为扁平化为单个查询参数

Swagger 2 ui 中发生单个查询参数时对象的图像扁平化

而 OpenApi 3 创建了一个 JSON 对象 …

api-doc swagger spring-boot swagger-2.0 openapi

5
推荐指数
1
解决办法
1126
查看次数

标签 统计

api-doc ×1

openapi ×1

spring-boot ×1

swagger ×1

swagger-2.0 ×1