Spring boot reusable springdoc-openapi parameter annotations

Question

I have few controller classes that all requires a header param. To document swagger I am adding this @Parameter annotation to all my endpoints:

    @Parameter(in = ParameterIn.HEADER, description = "some description", name = "some name", content = @Content(schema = @Schema(allowableValues = {VALUE1, VALUE2, VALUE3, VALUE4})))
    @GetMapping
    public void method(@RequestHeader .....) {
    //some code here
    }

Problem is I don't like the idea of repeating the same annotation all over the controller methods. Is there a nice clean solution to have a reusable annotation here?

Maciej · Accepted Answer · 2020-03-18 09:30:39Z

4

So partial fix is create my own custom interface like that:

@Target({PARAMETER, METHOD, FIELD, ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Parameter(in = ParameterIn.HEADER, description = "some description", name = "some name", content = @Content(schema = @Schema(allowableValues = {VALUE1, VALUE2, VALUE3, VALUE4})))
public @interface MyCustomAnnotation {
}

that way I can reuse that and save some code. Problem is when some values differ. For example if allowableValues differ between endpoints I can't reuse that one. I can't figure out how can I pass some arguments to my custom annotation to override the default values...

answered Mar 18, 2020 at 9:30

Maciej

5622 gold badges10 silver badges21 bronze badges

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

1 Comment

SSK Over a year ago

You can try this stackoverflow.com/a/60559044/3493829

Collectives™ on Stack Overflow

Spring boot reusable springdoc-openapi parameter annotations

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related