Spring REST API Swagger UI@ModelAttribute请求URL和参数类型

Question

我在尝试使我的swagger UI返回我想要的内容时遇到了一些问题。问题是我想将areaName显示为路径参数类型，而不是Swagger UI中的查询。我可以通过使用@Path可变String“areaName”来做到这一点。

但是我想在单独的请求类中验证区域名称，现在我尝试使用@Valid@ModelAttribute。这样做的问题是Swagger给了我一个无聊的请求URL，例如：

/v1/areas/{areaName}/系列？areaName=测试区

我希望它的显示方式和我使用< code>@PathVariable时一样:

/v1/areas/testarea/series？from=20151201

我曾尝试在requestclass中使用@ApiParam，甚至尝试hidden=true以在控制器中保留@PathVariable，并仅在request class中隐藏 以在Swagger UI中不获得areaName的副本，但隐藏似乎不起作用。我正在使用Swagger/SwaggerUI版本2.3.0。有什么想法吗？

请求类：

public class AreaSeriesRequest {

@ApiParam(value = "Area selector, wich area to get series from.", required = true)
@EnergyAreas
private String areaName;

public String getAreaName() {
    return AreaName;
}

public void setAreaName(String areaName) {
    this.areaName = areaName;
}

控制器：

@RequestMapping(value = "/{areaName}/series", method = GET, produces = json)
@ResponseStatus(HttpStatus.OK)
    public Page<GroupSeriesDto> getAreaSeriesPaginated(
            //@PathVariable String areaName,
            @Valid @ModelAttribute AreaSeriesRequest seriesRequest, BindingResult seriesResult,
            @ModelAttribute PagingRequest pagingRequest,
            Principal currentUser) {

Answer 1

因此，我解决这个问题的方法是仍然使用@PathVariable，但是我为这个参数做了一个单独的验证器，而不是areaName上的@Valid @ModelAttribute。

public class AreaValidator implements Validator {

private static final List<String> types = Arrays.asList(
        "ALL",
        "XX1",
        "XX2",
        "XX3",
        "XX4"
);

@Override
public boolean supports(Class<?> clazz) {
    return String.class.equals(clazz);
}

@Override
public void validate(Object target, Errors e) {
    String value = (String) target;

    if (value == null || !types.contains(value.toUpperCase())) {
        e.reject(String.format("Area '%s' does not exist", value));
    }
}

然后在控制器中使用它，如：

new AreaValidator().validate(areaName, seriesResult);

if (seriesResult.hasErrors())
throw new AreaNotFoundException(areaName);