No operations defined in spec!

[mikt]

Hi,
So I attempted to follow the getting started guide, and get inspiration from the sample projects, however for some reason my endpoint or models are not visible on the swagger UI, instead I'm faced with "No operations defined in spec!"

I would appreciate any tips to what I've might have missed :)

My controller/interface:

@Tag(name = "Test", description = "Just a test endpoint")
@RequestMapping(value = DEFAULT_PATH, produces = APPLICATION_JSON_VALUE)
@RestController
public interface TestEndpoint {
    String DEFAULT_PATH = "/test";

    String ID = "/{test-id}";

    @Operation(
            description = "Get test by test-id",
            summary = "Get test summary"
    )
    @ResponseStatus(code = HttpStatus.OK)
    @ApiResponses({
            @ApiResponse(
                    responseCode = HttpURLConnection.HTTP_OK + "",
                    description = "The request succeeded.",
                    content = @Content(schema = @Schema(implementation = TestModel.class))
            )
    })
    @GetMapping(value = ID)
    TestModel getAgreement(@Parameter(description = "Id of the test", required = true) @PathVariable("test-id") Long testId);
}

Application properties:

server.port=8090
application-description=@project.description@
application-version=@project.version@
springdoc.packages-to-scan=*
springdoc.paths-to-match=/*

My application runner

@SpringBootApplication
public class AuthApplication {

    @Bean
    public OpenAPI springShopOpenAPI(@Value("${application-version}") String appVersion) {
        return new OpenAPI()
                .info(new Info().title("HoN Core Auth API")
                        .description("Authentication & authorization API")
                        .version(appVersion)
                        .license(new License().name("(C) HoN")));
    }

//    @Bean
//    public GroupedOpenApi publicApi() {
//        String[] paths = {TestEndpoint.DEFAULT_PATH.concat("/**")};
//        return GroupedOpenApi.builder()
//                .group("public")
//                .pathsToMatch(paths)
//                .build();
//    }

    public static void main(String[] args) {
        SpringApplication.run(AuthApplication.class, args);
    }

}

My model:

@Schema(description = "This model represents a test result")
@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
@Builder
@Data
public class TestModel {
    @Schema(description = "Test description", example = "First test case")
    String description;

    @Schema(description = "Test id", example = "1", required = true)
    @NotNull
    Long id;

    @Schema(description = "Was the test a success", example = "true", required = true)
    @NotNull
    Boolean isSuccess;
}

[bnasslahsen]

@mikt,

Where is the implementation of your interface TestEndpoint?

[mikt]

@bnasslahsen I didn't make an implementation yet, this was just supposed to be my contract.

[bnasslahsen]

@mikt,

This can be contract, but an interface is not going to generate a spring controller.
If the controller does not effectively exist, springdoc-openapi will not detect it.

You need to add the implementation class even it's not yet complete...
You can have a look at the project tests for samples.

[mikt]

Hi, so I added a small implementation, but it's still not showing anything for me:

@RestController
public class TestResource implements TestEndpoint {
    @Override
    public TestModel getTest(Long testId) {
        return TestModel
                .builder()
                .description("Test case " + testId)
                .id(testId)
                .isSuccess(true)
                .build();
    }
}

[bnasslahsen]

@mikt,

Did you have a look at the repo demos ?
I am sure which documentation you are getting from this configuration :

springdoc.packages-to-scan=*
springdoc.paths-to-match=/*

Remove these two settings, which seems useless.

If you are still facing the same issue, then attach your project or add the link to your github and we will have a look at it.

[dafuemu]

Hi! I am having same issue. Because i was expecting to have the swagger ui generated by having all the annotation on the interface, not the implementation.
https://springdoc.org/#does-this-library-supports-annotations-from-interfaces
Did i misunderstand the info on that link?? I provided an implementation

@RestController("/api/")
public interface IUserApi {

  @ApiResponse(responseCode = "200", description = "This is ok indeed" )
  @GetMapping("/users/{id}")
  Mono<String> getUser(@PathVariable long id);
}

public class UserApi implements IUserApi {

  @Override
  public Mono<String> getUser(long id) {
    return Mono.just("Hello Docs");
  }
}

in gradle:

compile group: 'org.springdoc', name: 'springdoc-openapi-webflux-ui', version: '1.4.8'
implementation 'org.springframework.boot:spring-boot-starter-webflux'

Thanks

[geld0r]

I am having the same issue. Did anyone find a solution or workaround?
I don't want to move all the annotations to the implementation as I find that separation way cleaner...

[shopizer-ecommerce]

same issue

[bnasslahsen]

@shopizer-ecommerce,

Your comment is not useful, without providing any Reproducible Example.
Make sure you Provide the link to a Minimal, Reproducible Example - with HelloController that reproduces the problem.

You can read the guidance here.

[jerryleooo]

Hi @bnasslahsen
I have the same issue, the version I am using is 1.6.6. I am not using yml file to configure, and instead there is only a simple @Configuration:

@Configuration
public class DocsConfig
{
    @Bean
    public GroupedOpenApi api()
    {
        return GroupedOpenApi.builder()
                .group("xxx")
                .packagesToScan("xxx")
                .build();
    }

And I only use dependency springdoc-openapi-ui

at /v3/api-docs, I can see the paths I defined inside the controller are listed. So I guess somewhat the configure works.

but on swagger-ui/index.html, "No operations defined in spec!" is displayed.

[bnasslahsen]

@jerryleooo,
Make sure you Provide the link to a Minimal, Reproducible Example - with HelloController that reproduces the problem.

[jerryleooo]

Hi @bnasslahsen the MVP you asked is here, hope it helps, thanks.