Spring + Springfox + Header 参数

Question

@RequestMapping(...)
public Foo getFoo(@HeaderParam("header") final String header) {
    ...
}

像上面那样添加 @HeaderParam 方法参数 springfox 将其拾取，当我查看 swagger-ui 时，它有一个标题字段。这正是我想要的。有没有一种方法可以告诉 springfox 在一组方法中包含此 header 参数，而不必在方法本身中包含参数？我们真正要做的是使用 header 的 servlet 过滤器，我们希望通过 swagger-ui 轻松设置它。

Answer 1

您可以在案卷定义中使用 globalOperationParameters。例如

new Docket(...)
            .globalOperationParameters(
        Arrays.asList(new ParameterBuilder()
            .name("header")
            .description("Description of header")
            .modelRef(new ModelRef("string"))
            .parameterType("header")
            .required(true)
            .build()))

见 #22在文档中了解更多信息。