SpringFox docket将请求参数添加到特定端点

时间:2017-11-30 10:22:27

标签: spring rest spring-mvc swagger springfox

我正在使用springfoxrest end points生成招摇网址。我有一个特定的休息端点,在控制器级别上不需要请求参数,但需要预先处理请求的filter上的请求参数。

我想在Docket定义中的Docket上定义一个请求参数,而不是在控制器上定义请求参数,因为在控制器上注释参数使得它非常脏并且难以阅读。

换句话说,我想在不使用ApiImplicitParams的情况下定义swagger参数,而是在Docker上定义它。

有什么建议吗? 感谢

1 个答案:

答案 0 :(得分:0)

这可以通过在Docket构建器上使用globalOperationParameters方法来完成。

    return new Docket(DocumentationType.SWAGGER_2)
    ...
    .globalOperationParameters(
        newArrayList(new ParameterBuilder()
            .name("someGlobalParameter")
            .description("Description of someGlobalParameter")
            .modelRef(new ModelRef("string"))
            .parameterType("query")
            .required(true)
            .build()))