Support REST Controllers with default empty @RequestMapping (without any @RequestMethod)

[neodem]

I'm having trouble getting this to work. I've started with a working SpringBoot (v2.2.2) app with a working @RestController. To get springdoc to work I've included the dependency in my pom, built and started my service. I've then browsed to the api-docs endpoint and I get :
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"paths":{},"components":{}}

Am I missing a step? I was assuming at runtime it would scan my code, find the @RestController, find the @RequestMapping methods and generate the api from that.

As a second attempt, I decided to annotate one of my methods with swagger @Operation annotations and still things don't get picked up.

Lastly, I tried specifying the package with my Controller manually using springdoc.packagesToScan and that didn't work either.

This feels like springdoc isn't seeing my Controller.. even though spring does.. it's perfectly active and it works..

Not sure what I'm missing..

[bnasslahsen]

Hi @neodem,

By default, you just need to add the springdoc-ui dependency, and you should see all the API when browsing to /v3/api-docs

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.2.28</version>
</dependency>

You can have a look a the demos samples:

• https://github.com/springdoc/springdoc-openapi-demos

Please read the section of Using GitHub Issues:

• https://github.com/springdoc/springdoc-openapi/blob/master/CONTRIBUTING.adoc

If you are still facing this problem, please add the sample code or your git repository link to reproduce and this issue will be reopened.

[neodem]

I have posted on stack overflow with no luck, so I decided to dig into this myself. After a few hours of debugging I figured out what is going on in my situation.

when defining a REST Controller, spring allows you to declare @RequestMapping(value = "/init") with no explicit Method and will accept a POST request. However, in your OpenApiResource class you make a call to calculatePath, in there (on line 129) you make a call to the spring RequestMappingInfo.getMethodsCondition() and in my case you get back no results (since the method wasn't explicitly defined in the annotation).. thus no request method => no path calculated.

If I explicitly define the method: @RequestMapping(value = "/init", method = RequestMethod.POST) everything works as expected.

I think that at the least you should mention this in your documentation: "when defining @RequestMapping annotations you must declare a method and not rely on Springs default because springdoc won't find it).

I think a better solution would be to come up with a sensible default when nothing is explicity declared in the annotation.

[bnasslahsen]

Your description is now more accurate about the reason why the controller was not displaying.

The method value of @RequestMapping defaults to an empty array
We will add on the documentation that people should always be explicit, to avoid possibly nondeterministic behavior if multiple annotations can apply to the same request URL.

Note that by default, all the following methods are accepted by Spring 5: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS.

[maratondiadelvidriero]

I had the same issue and solved by replacing @controller by @RestController. It will be very good to indicate this in the documentation.

[bnasslahsen]

@maratondiadelvidriero,

You can have a look here:

• https://springdoc.org/faq.html#my-rest-controller-using-controller-annotation-is-ignored

[wxy0724]

When I use @RequestMapping without explicitly specifying the HTTP method, and simultaneously set @operation(method = GET) in my controller, the Swagger UI displays all HTTP method types (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS) for the endpoint.

Observed Behavior:
The generated Swagger documentation shows the endpoint as supporting all HTTP methods instead of only GET.

Questions:

1. Is this a potential bug in @operation's method attribute handling?
2. Or am I misunderstanding the proper usage of @operation(method)?

Environment:
Spring Boot 3.2.4
springdoc-openapi-starter-webmvc-ui v2.8.1