@PathVariable interpreted as a query parameter when annotated on an interface

Versions:

springfox 2.9.2 Spring boot web starter 2.0.4

there seems to be a bug where PathVariable gets interpreted as a query parameter. It only seems to occur when using a style where @PathVariable is annotated on the interface (e.g. it works properly when annotated on the controller directly)

Given an interface:

public interface SampleApi {
 
          @RequestMapping(
              value = "/test/{var1}",
              consumes = {"application/json"},
              method = RequestMethod.PUT)
          ResponseEntity<Void> test(
              @ApiParam(value = "some named var1", required = true)
              @PathVariable("var1")
                  Long var1
              );
}

And implementation:

@Controller
public class SampleApiImpl implements SampleApi {
 
        public ResponseEntity<Void> test(Long var1) {
                return null;
        }
 
}

Yields:

"/test/{var1}": {
                        "put": {
                                "tags": ["sample-api-impl"],
                                "summary": "test",
                                "operationId": "testUsingPUT",
                                "consumes": ["application/json"],
                                "produces": ["*/*"],
                                "parameters": [{
                                        "name": "var1",
                                        "in": "query",
                                        "description": "var1",
                                        "required": false,
                                        "type": "integer",
                                        "format": "int64"
                                }],
 

[magnus-larsson]

This seems to work now?

I tried it using springfox-swagger2 3.0.0-SNAPSHOT together with Spring Boot 2.1.0-RC1 (i.e. Spring 5.1.1-RELEASE).

An interface declaration like:

public interface ProductService {
    @GetMapping(
        value    = "/product/{productId}",
        produces = "application/json")
     Product getProduct(@PathVariable int productId);

Results in a swagger definition like:

"paths": {
    "/product/{productId}": {
      "get": {
        "tags": [
          "product-service-impl"
        ],
        "summary": "getProduct",
        "operationId": "getProductUsingGET",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "description": "productId",
            "required": true,
            "type": "integer",
            "format": "int32"
          }
        ],

i.e. “in” equals to “path”

An interface declaration like:

public interface RecommendationService {
    @GetMapping(
        value    = "/recommendation",
        produces = "application/json")
    List<Recommendation> getRecommendations(@RequestParam(value = "productId", required = true) int productId);

Results in a swagger definition like:

  "paths": {
    "/recommendation": {
      "get": {
        "tags": [
          "recommendation-service-impl"
        ],
        "summary": "getRecommendations",
        "operationId": "getRecommendationsUsingGET",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "productId",
            "in": "query",
            "description": "productId",
            "required": true,
            "type": "integer",
            "format": "int32"
          }
        ],

i.e. “in” equals to “query”

Or, am I missing something?

[dilipkrish]

Great that its working out of the box!