使用Spring自定义解析器注释的Swagger OpenApi动态查询参数名称

Question

我试图找出如何指示到SpringDocOpenApi一个自定义对象正在生成使用HandlerMultiodArgumentResolver拦截一些传入的请求参数并从中创建一个对象。这个概念实际上与Spring使用@Pagable所做的相同。

以下是我的自定义对象的某些部分：

class FlightRequestHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
FlightRequestHandlerMethodArgumentResolver() {
}

@Override
boolean supportsParameter(final MethodParameter parameter) {
    return FlightRequest.class.equals(parameter.getParameterType());
}

@Override
Object resolveArgument(
        final MethodParameter parameter,
        final ModelAndViewContainer mavContainer,
        final NativeWebRequest webRequest, final WebDataBinderFactory binderFactory) throws Exception {
    final Map<String, String[]> parameterMap = webRequest.getParameterMap()
    // query param names are configurable
    // implementation about finding query param names is ommited
    return new FlightRequest(parameterMap)
}

FlightRequestclass:

public class FlightRequest {

@Parameter(name = "startDate")
private final LocalDate startDate;

@Parameter(name = "endDate")
private final LocalDate endDate;

FlightRequest (LocalDate startDate, LocalDate endDate) {
    this.submissionStartDate = submissionStartDate;
    this.submissionEndDate = submissionEndDate;
}

使用带有默认查询参数名称的FlightRequest的控制器：

@RequestMapping(value = "/flights", method = RequestMethod.GET)
Flights flights(FlightRequest flightRequest, HttpServletResponse response) {
    return flightSearchService.retrieveFlights(flightRequest);
}

使用带有自定义查询参数名称的FlightRequest的控制器：

@RequestMapping(value = "/current-flights", method = RequestMethod.GET)
Flights flights(@FlightRequestParams(fromDateParamName="current-flights-from", toDateParamName="current-flights-till) FlightRequest flightRequest, HttpServletResponse response) {
    return flightSearchService.retrieveFlights(flightRequest);
}

正如您在上面的示例中看到的，每个endpoint都可以覆盖默认的查询参数名称
我如何向Spring Doc表明这一点？

Answer 1

似乎您在这里使用的不是spring注释，而是您自己的：@FlightRequestParams。

如果您真的希望动态添加默认值，那么您可以为您的注释编写自己的注释委托方法参数自定义程序，就像为@PageableDefault编写一样。然后宣布它为春豆，如下所示。

或者最简单的方法，是使用@Parameter注释声明参数值。您可以看到PageableAsQueryParam的示例。