Swagger或springfox忽略了Pageable参数

时间:2018-06-06 14:31:47

标签: java rest swagger springfox

我正在尝试使用springfox构建swagger文档。

我的休息方法是

@RequestMapping(value = "/filter", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public final Page<SomeOtherObj> filter(@RequestBody SomeObj dto, Pageable pageable) {...}

在输出中我有参数列表的文档:

"parameters": [
    {
        "in": "body",
        "name": "dto",
        "description": "dto",
        "required": true,
        "schema": {
            "$ref": "#/definitions/SomeOdj"
        }
    }
],

Pageable在哪里?为什么忽视swagger?

1 个答案:

答案 0 :(得分:1)

我猜是因为它没有标记为@RequestBody它会被忽略。无论如何,您可以使用@ApiParam注释隐式标记它。 包含在最终规范中。

@RequestMapping(value = "/filter", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public final Page<SomeOtherObj> filter(@RequestBody SomeObj dto, @ApiParam(name = "Pageable filter", required = false) Pageable pageable) {...}

<强>更新

根据评论

  

v 2.8.0中出现问题。新版本2.9.0一切正常   Springfox Swagger。它在旧版本中运行良好(我尝试过   2.6.1