Spring + Springfox + Header Parameters

Question

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

Adding a @HeaderParam method parameter as above springfox picks it up and when I look at the swagger-ui it has a field for the header. This is exactly what I want. Is there a way I can tell springfox to include this header parameter on a set of methods without having to include the parameters on the method itself? What we really have going on is a servlet filter which uses the header and we'd like an easy to set it through the swagger-ui.

@HeaderParam adds a body type parameter in Swagger UI whereas the globalOperationParameters method adds a fine header type field (but is global) — Julien
– Julien, Commented Nov 25, 2016 at 8:37
For a proper header type parameter specific to one method (non global), see stackoverflow.com/questions/40801442/… — Julien
– Julien, Commented Nov 25, 2016 at 9:23

Supun Wijerathne · Accepted Answer · 2018-08-22 08:42:39Z

80

You could use the globalOperationParametersin the docket definition. For e.g.

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

See #22 in the documentation for more information.

edited Aug 22, 2018 at 8:42

Supun Wijerathne

13.1k11 gold badges73 silver badges101 bronze badges

answered Apr 14, 2016 at 3:17

Dilip Krishnan

5,4973 gold badges40 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

Gandhi Over a year ago

Could you please have a look at this question - stackoverflow.com/questions/42348630/…

user09 Over a year ago

@Dilip I am getting a compile error "The method newArrayList(Parameter) is undefined for the type SwaggerConfiguration" while trying to use this snippet. I am using Swagger version 2.8.0. Aything I am missing? Could you pls suggest

Dilip Krishnan Over a year ago

That snippet is defined in a bean definition method as shown 👇. Perhaps you're not placing the snippet correctly. Also hopefully you're removing the ... etc.

yngwietiger Over a year ago

Worked for me, but I ended up creating the parameter above the Docket creation, for readability.

Wafula Samuel Over a year ago

Great, so helpful

|

Vijay · Accepted Answer · 2017-03-21 08:57:34Z

19

One more explained answer for same :-

@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);
    }

answered Mar 21, 2017 at 8:57

Vijay

5,0781 gold badge35 silver badges38 bronze badges

1 Comment

Nazeel Over a year ago

Thank you for the answer it helped a lot, change last return statement to return new Docket(DocumentationType.SWAGGER_2).select() .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build().pathMapping("").globalOperationParameters(aParameters);

user2204107 · Accepted Answer · 2023-03-31 05:15:44Z

globalOperationParameters is depressed, use RequestParameter and globalRequestParameters with springfox-boot-starter:3.0.0

    @Bean
    public Docket api() {
        List<RequestParameter> aParameters = new ArrayList<>();

        RequestParameterBuilder aParameterBuilder = new RequestParameterBuilder();
        aParameterBuilder.name("appId").in(ParameterType.HEADER).required(true);
        aParameters.add(aParameterBuilder.build());
        aParameterBuilder.name("appSecret");
        aParameters.add(aParameterBuilder.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any()).paths(PathSelectors.ant("/api/*")).build().pathMapping("")
                .globalRequestParameters(aParameters);
    }

Collectives™ on Stack Overflow

Spring + Springfox + Header Parameters

3 Answers 3

7 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

7 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related