Springdoc-OpenAPI with path parameters and command object

Question

I am getting validation errors in my Springdoc generated OpenAPI spec and can't see to find an example online that matches how my Java code is formed.

I am trying to generate an OpenAPI spec with Springdoc for a Spring Boot controller. I have a mapping for a path that has multiple path variables and the method signature accepts a command object (the command object is automatically constructed from these path variables). Swagger-UI.html seems to work more or less but the generated JSON/YAML spec does not appear to be valid.

Code snippet I'm referring to:

@GetMapping("/myPath/{foo}/{bar}/{baz}")
public Mono<MyServiceResponse> doSomethingInteresting(@Valid DoSomethingInterestingCommand command) {
    return interestingService.doSomethingInteresting(command);
}

The OpenApi snippet this generates is:

paths:
  '/myPath/{foo}/{bar}/{baz}':
    get:
      tags:
        - my-controller
      operationId: doSomethingInteresting
      parameters:
        - name: command
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/DoSomethingInterestingCommand'

This then yields errors such as this:

Semantic error at paths./myPath/{foo}/{bar}/{baz}
Declared path parameter "foo" needs to be defined as a path parameter at either the path or operation level

What should I do differently in order to get the generated spec to be well-formed? I am also curious as to why the swagger-ui.html page seems to be working OK, but that is less critical.

I think will be a better idea to raise an issue at github.com/springdoc/springdoc-openapi/issues — Debargha Roy
– Debargha Roy, Commented Feb 10, 2021 at 11:52

brianbro · Accepted Answer · 2021-05-23 16:44:55Z

8

To generate the correct openAPI spec, you can add the swagger-annotations.

@Parameter(in = ParameterIn.PATH, name ="foo" ,schema = @Schema(type = "string"))
@Parameter(in = ParameterIn.PATH, name ="bar" ,schema = @Schema(type = "string"))
@Parameter(in = ParameterIn.PATH, name ="baz" ,schema = @Schema(type = "string"))
@GetMapping("/myPath/{foo}/{bar}/{baz}")
public Mono<MyServiceResponse> doSomethingInteresting(@Valid @Parameter(hidden = true) DoSomethingInterestingCommand command) {
    return interestingService.doSomethingInteresting(command);
}

answered May 23, 2021 at 16:44

brianbro

4,9653 gold badges30 silver badges44 bronze badges

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

1 Comment

matt forsythe Over a year ago

Exactly what I needed - thanks!

Zhenya · Accepted Answer · 2022-06-28 08:40:41Z

-1

Pay attention please, that @Parameter is not shown in UI with POST. Because There is only body in POST. So you should use either @io.swagger.v3.oas.annotations.parameters.RequestBody(description="blabla") and @org.springframework.web.bind.annotation.RequestBody

answered Jun 28, 2022 at 8:40

Zhenya

796 bronze badges

2 Comments

ethry Over a year ago

Please provide an explanation to your code - it is very hard to understand something when it isn't explained.

matt forsythe Over a year ago

This is not an answer

Collectives™ on Stack Overflow

Springdoc-OpenAPI with path parameters and command object

2 Answers 2

1 Comment

2 Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Related