Sharing @ApiImplicitParams across resources

[pavlos163]

Q	A
Bug or feature request?	Bug
Which Swagger-Core version?	1.5.17
Which Java version?	1.8.0_131
Which JAX-RS framework & version?	1.19

Almost all of my endpoints include a @Context RequestContext requestContext parameter like the above. That object includes common path parameters such as language and country.

public interface MyResource {

    @GET
    @Path("mypath")
    Response anExampleEndpoint(@Context RequestContext requestContext,
                               @PathParam("something") Something something);

    ...
}

What I can do for this specific interface is add a ApiImplicitParams above the interface name, and that works fine.

@ApiImplicitParams({
        @ApiImplicitParam(name = "language", value = "Caller's language", required = true, dataType = "string", paramType = "path"),
        @ApiImplicitParam(name = "country", value = "Caller's country", required = true, dataType = "string", paramType = "path"),
        ...
})

However, I don't want to do that for every one of my resources, as they are many and nearly all of them have a RequestContext object inside their methods.

What are the solutions available here? I tried adding the @ApiImplicitParams in the RequestContext class like this:

@ApiImplicitParams({
		@ApiImplicitParam(name = "language", value = "Caller's language", required = true, dataType = "string", paramType = "path"),
		@ApiImplicitParam(name = "country", value = "Caller's country", required = true, dataType = "string", paramType = "path"),
                ...
})
public class RequestContext {
...
}

But it didn't read them.

Can it be done by overriding the Swagger reader? Or by using inheritance somehow? Or any other way?

Thanks.

[pavlos163]

Solved with extending a common interface and adding @ApiImplicitParams there.

[pavlos163]

As a follow-up, would it be possible to automatically read that from a @Context object without having to maintain that list of @ApiImplicitParams?