Problem with subresource detection when using dependency injection in Jersey 2

[joscarsson]

This works fine:

@Path("/{objectId: [a-fA-F0-9]{32}}")
@ApiOperation(value = "subresource", response = SomeSubResource.class)
public SomeSubResource continueInSubResource() {
  return new SomeSubResource();
}

The problem occurs when using Jersey dependency injection for creating the resources. The code is then changed to this:

@Path("/{objectId: [a-fA-F0-9]{32}}")
@ApiOperation(value = "subresource", response = SomeSubResource.class)
public Class<SomeSubResource> continueInSubResource() {
  return SomeSubResource.class;
}

That is, we only tell Jersey which type of class we want, and Jersey dependency injection instantiates the correct class (passing in the dependencies to the constructor automatically). However, this seems to confuse swagger, which does not detect this subresource at all.

[fehguy]

hi, the regex in path is not supported

[joscarsson]

Ok, but that's not the problem here. If you compare my two snippets of example code, the first one is actually working (even though it has regexp in path), but the other one is not. It is related to the SomeSubResource vs Class<SomeSubResource>, not the regexp.

I created an issue for the regexp, which seems to work fine in swagger-core but not in swagger-ui (see here swagger-api/swagger-ui#356). Perhaps the solution to that issue is to simply cut the regexp from the path in swagger-core instead of trying to support in in swagger-ui? Please advise if I should create a new issue for the regexp part in swagger-core and close the issue I created in swagger-ui.

[SirWellington]

I'm facing this same issue too. Any updates? Is there something that can be done for sub resources created in this way?

[SirWellington]

Update: Actually after chaging my code from

public Resource getSubResource()
{
return Resource.from(SubResource.class);
}

to

public Class<SubResource> getSubResource()
{
return SubResource.class;
}

Works well with HK2 and Jersey's lifecycle management.

[mrksdck]

I am using Jersey 1.18, but maybe the issue is related.
In my example app several @Path annotations are used to describe an endpoint, also illustrated in the following snippets.
jerseys servlet url-pattern is /rest/* and with the StringResource, the path goes on with /string/static/

@Path("/string")
public class StringResource {

    @Path("static")
    public Class<StaticStringResource> getStaticStringResource() {
        return StaticStringResource.class;
    }
}

Class StaticStringResource is the subresource and is preceeded by the path : /string/static/ as also annotated in @Api
The method paths (with base path) are /rest/string/static/hello and /rest/string/static/{string}

Api(value ="/string/static")
public class StaticStringResource {

    @ApiOperation( value ="hello world")
    @GET
    @Path("/hello")
    public String getStaticHelloWorld(){
        return "Hello World";
    }


    @ApiOperation( value ="identity function")
    @GET
    @Path("{string}")
    public String getStatic(@PathParam("string") String string){
        return string;
    }
}

The json output of /rest/string/static/ is as follows:

{
  "apiVersion": "0.1",
  "swaggerVersion": "1.2",
  "basePath": "http://localhost:8080/rest",
  "resourcePath": "/string/static",
  "apis": [
    {
      "path": "/{string}",
      "operations": [
        {
          "method": "GET",
          "summary": "identity function",
          "notes": "",
          "type": "string",
          "nickname": "getStatic",
          "parameters": [
            {
              "name": "string",
              "required": true,
              "type": "string",
              "paramType": "path",
              "allowMultiple": false
            }
          ]
        }
      ]
    },
    {
      "path": "/hello",
      "operations": [
        {
          "method": "GET",
          "summary": "hello world",
          "notes": "",
          "type": "string",
          "nickname": "getStaticHelloWorld",
          "parameters": []
        }
      ]
    }
  ]
}

Since the resourcePath is not feeded by the jerseys @Path annotation the method paths are somewhat partial.
If i click the "Try it out!" button on hello the url is http://localhost:8080/rest/hello
It seems the @Path annotations in StringResource are not used.

[webron]

@mbde - which version of swagger-core do you use?

[webron]

@mbde - never mind, just saw the original issue.

[mrksdck]

@webron and @fehguy : I think my issue is not relly related with the original issue.
Is the @path annotation only used in class/method of the endpoint?

[webron]

As opposed to?

[mrksdck]

as in the example, the path to the endpoint si composed of several @Path usages in different classes.
This usage of these annotations (e.g. StringResource), doesnt seem to work well with swagger