Spring Springfox标头参数

Question

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

如上所述，添加一个@HeaderParam方法参数后，springfox会将其选中，当我查看swagger ui时，它有一个用于头的字段。这正是我想要的。我可以告诉springfox在一组方法上包含这个头参数，而不必在方法本身上包含参数吗？我们真正要做的是一个servlet过滤器，它使用头，我们希望通过swagger ui轻松设置它。

Answer 1

同一问题的另一个解释:

@Bean
    public Docket api() {
        //Adding Header
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("headerName").modelRef(new ModelRef("string")).parameterType("header").required(true).build();
        List<Parameter> aParameters = new ArrayList<Parameter>();
        aParameters.add(aParameterBuilder.build());
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build().apiInfo(apiInfo()).pathMapping("").globalOperationParameters(aParameters);
    }

Answer 2

您可以在待办事项定义中使用globalOPationParameters。对于例如。

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

更多信息见文件中的#22。