Spring REST可分页/查询Swagger中的参数

Question

我正在尝试在我的 REST 服务中实现分页。

取1:

public Page<Item> getPagedItems(Pageable pageable)

这是SpringFox / Swagger中的一个已知错误，Swagger页面显示了错误的参数名。另外，我只想要佩奇

第二次:

public Page<Item> getPagedItems(@RequestParam(name="page", required=true) int page, @RequestParam(name="page", required=true) int size)

这给了我正确的参数，但是它不允许我设置参数描述或示例值。

取3：

@ApiImplicitParams({
    @ApiImplicitParam(name="page", value="page description", required=true, example="0", dataType="int"),
    @ApiImplicitParam(name="size", value="size description", required=true, example="10", dataType="int")
})
public Page<Item> getPagedItems(int page, int size)

这还有另一个错误，在这个错误中，例如="0"不起作用，但是除了一个有效的值之外，所有其他值都有效，哈哈。如果我将数据类型更改为字符串，那么它将显示0示例值，但它将允许您在输入框中输入任何内容。还尝试了“0”、“0.0”、“0\0”等。诸如此类的东西。

如果我不设置示例，那么Springfox会抛出一个异常，抱怨没有示例，哈哈。我能做的最接近的事情是两个都放0，两个都放空白。呃。0/10不是一个好的选择，因为0不起作用，但10起作用。

知道如何让0的示例工作吗？Spring Fox似乎没有得到很好的支持，即使是开源，所以GitHub上没有响应。

或者其他有例子和描述的方式？

Answer 1

我们创建了一个继承的注释并使用它：

 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@ApiImplicitParams({
    @ApiImplicitParam(name = "page",  dataTypeClass = int.class,defaultValue = "0", example = "0", paramType = "query", value = "Results page you want to retrieve (0..N)"),
    @ApiImplicitParam(name = "size", dataTypeClass = int.class ,example = "10", paramType = "query", value = "Number of records per page."),
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataTypeClass=String.class, paramType = "query", value = "Sorting criteria in the format: property(,asc|desc). "
            + "Default sort order is ascending. " + "Multiple sort criteria are supported.")  
})
public @interface ApiPagingParams {

}

用法

@ApiPagingParams
@ResponseStatus(HttpStatus.OK)
@GetMapping("/entity") 
ResponseEntity<Page<...>> getSurveyEntityList(@ApiIgnore("see @ApiPagingParams") @PageableDefault(page = 0, size = 10) Pageable pageable,...)