No operations defined in spec! while specifying multiple paths in swagger ui

Question

I want to display two REST API endpoints in Swagger ui: /cart and /post.

When I specify either /cart or /post works fine but with both showing me error as

No operations defined in spec!

in swagger-ui

@Bean
public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.ant("/cart"))
        .paths(PathSelectors.ant("/post"))
        .build();
}

return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage(("com.valens.compony"))) .paths(Predicates.or( PathSelectors.regex("/cart"),PathSelectors.regex("/post"))) .build() .pathMapping("/") i found this solution but it only works in java not in scala — Navin Gelot, May 11 '18 at 13:33

score 4 · Answer 1 · answered Dec 31 '20 at 13:37

4

Another option is to use .paths(PathSelectors.any()) instead of .paths(PathSelectors.ant("/cart")) and .paths(PathSelectors.ant("/post"))

answered Dec 31 '20 at 13:37

Cesar Nicolás Cabo

41
3

score 1 · Answer 2 · answered Feb 09 '22 at 15:19

1

With Spring boot 2.6.x you also need:

spring:  
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

answered Feb 09 '22 at 15:19

Peyman

250
3
8

This trick solves my problem. Can you elaborate how you came to this fix @Peyman ? I'd be great if you can share the original doco/issue point this one out. – tuan.dinh Mar 25 '22 at 01:09

score 0 · Answer 3 · answered Feb 14 '22 at 16:29

It because you use AND condition

  public ApiSelectorBuilder paths(Predicate<String> selector) {
    pathSelector = pathSelector.and(selector);
    return this;
  }

you can combine conditions by using OR clause

.paths(PathSelectors.ant("/cart").or(PathSelectors.ant("/post")))

score 0 · Answer 4 · answered Dec 07 '22 at 07:31

Please add package xxxx as root package so It can scan swagger config in all class

public String getApplicationBasePath() {
                    return swaggerPath;
                }
            }).select().apis(RequestHandlerSelectors.basePackage("xxxx")).build()
                    .securitySchemes(Arrays.asList(securitySchema()))
                    .securityContexts(Collections.singletonList(securityContext())).apiInfo(metaData());

Ait Friha Zaid · Answer 5 · 2023-05-31T14:22:30.443

this the solution : is add the the path where exactly you have the controllers classe

exemple : "org.zaid.aitfriha.controller.api" is the path where exactly you have controllers

.apis(RequestHandlerSelectors.basePackage("org.zaid.aitfriha.controller.api"))

dont use org.zaid.* or org.zaid.aitfriha.* or org.zaid.aitfriha.controller.*

Be careful with "/api/AbsenceRequest" dont works it must be "/api/absenceRequest"

@RestController
@RequestMapping("/api/absenceRequest")
@CrossOrigin("*")

score 0 · Answer 6 · answered Jul 27 '23 at 20:10

You can try setting the base package to the RequestHandlerSelectors object in your Swagger Config class. You can point to the specific package where you have your OpenAPI annotations added, i.e. "controller", or just leave it pointing to the root, spring will scan all the nested packages.

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
            .paths(PathSelectors.any())
            .build().apiInfo(apiInfoMetaData());
}

No operations defined in spec! while specifying multiple paths in swagger ui

6 Answers6

Linked