Spring docs - Открытый API 3 - Как установить значения по умолчанию для тела?

Я использую Spring Boot + Spring Data Mongo + Spring REST + Spring HATEOAS для реализации конечных точек REST.

Поскольку мы передаем более 5 параметров запроса (проприетарная настройка организации, предполагается, что она не передается), поэтому я решил создать класс EmployeeDto и передать этот класс в контроллер.

@GetMapping(value = "/employees", produces = {MediaType.APPLICATION_JSON })
public ResponseEntity<PagedModel<EmployeeModel>> findEmployees(
        EmployeeDto dto,
        @Parameter(hidden=true) String sort,
        @Parameter(hidden=true) String order,
        @Parameter(hidden=true) Pageable pageRequest) {

    // Add needed logic 
    ......
    ......
    ......
    PagedModel<EmployeeModel> model = employeePagedAssembler.toModel(response, employeeAssembler);

    return new ResponseEntity<>(model, HttpStatus.OK);
}

Пользовательский интерфейс Swagger выглядит как -

{
  "firstName": "string",
  "lastName": "string",
  "age": 0,
  "languageCd": "string",
  "isActive": "string",
  "email": "string",
  "regionCd": "string"
}

Команда CURL:

curl -X GET "http://localhost:8080/employee-data/employee/geographies?firstName=string&lastName=string&age=0&languageCd=string&isActive=string&email=string®ionCd=string&page=0&size=25&sort=firstName&order=ASC "-H" принять: приложение / json "

EmployeeDto.java

@AllArgsConstructor
@NoArgsConstructor
@Data
@Builder
@Schema
public class EmployeeDto {
    @Schema(description = AppConstants.FIRSTNAME, defaultValue="")
    private String firstName; 

    @Schema(description = AppConstants.LASTNAME, defaultValue="")
    private String lastName; 

    @Schema(description = AppConstants.AGE, defaultValue="")
    private Integer age; 

    @Schema(description = AppConstants.LANG_CD_DESC, defaultValue="0")
    private String languageCd;

    @Schema(description = AppConstants.ISACTIVE, defaultValue="")
    private String isActive; 

    @Schema(description = AppConstants.EMAIL, defaultValue="")
    private String email; 

    @Schema(description = AppConstants.REGION_CD_DESC, defaultValue="")
    private String regionCd;
}

Я ищу -

1) Как установить значение по умолчанию для каждого поля вместо «строки», которая кажется приближающейся по умолчанию?

2) Как просто разрешить видеть фактические параметры запроса в пользовательском интерфейсе OAS3? Валюта, похоже на тело.


spring springdoc springdoc-openui
person Pra_A    schedule 25.03.2020    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Мне удалось решить эту проблему самостоятельно. example - Provides an example of the schema. When associated with a specific media type, the example string shall be parsed by the consumer to be treated as an object or an array.

Код -

@AllArgsConstructor
@NoArgsConstructor
@Data
@Builder
@Schema
public class EmployeeDto {
    @Schema(description = AppConstants.FIRSTNAME, type = "string", example = " ")
    private String firstName; 

    @Schema(description = AppConstants.LASTNAME, type = "string", example = " ")
    private String lastName; 

    @Schema(description = AppConstants.AGE, type = "string", example = "null")
    private Integer age; 

    @Schema(description = AppConstants.LANG_CD_DESC, type = "string", example = " ")
    private String languageCd;

    @Schema(description = AppConstants.ISACTIVE, type = "string", example = " ")
    private String isActive; 

    @Schema(description = AppConstants.EMAIL, type = "string", example = " ")
    private String email; 

    @Schema(description = AppConstants.REGION_CD_DESC, type = "string", example = " ")
    private String regionCd;
}

и в контроллере просто добавьте метод ниже, который будет сброшен, если отправлено значение "null", если да, он сбросит его на "" и то же самое для Integer на null.

public static Object getDefaulter(Object obj) {
    Arrays.stream(obj.getClass().getDeclaredFields()).map(f -> {
        f.setAccessible(true);
        try {
            // set null values only if found String value as "null"
            if (Objects.equals(f.get(obj), "null")) {
                f.set(obj, "");
            }else if(Objects.equals(f.get(obj), 0)) {
                f.set(obj, null);
            }
        } catch (IllegalArgumentException | IllegalAccessException e) {
            //
        }
        return f;
    }).collect(Collectors.toList());
    return obj;
}
person Pra_A    schedule 07.04.2020
comment
не работает. Строка с пробелом игнорируется, как и пустая. - person SledgeHammer; 31.12.2020