@ApiOperation responseContainer

[vvicario]

Hi, I'm having issues trying to set the responseContainer to List or Array. Swagger UI is displaying Model Shema tab empty and Model looks like: List[[org.com.myapp.http.service.MyAPI$ObjectDesc].

I'm using:
dropwizard-swagger: 0.5.3
dropwizard: 0.7.0
Swagger API:1.3.12
Swagger UI: v2.1.4-M1

I really appreciate if someone has any suggestion

[fehguy]

Please share you annotation values.

[vvicario]

@fehguy This is the annotation that I'm using.

@apioperation(value = "Querying for Objects by Name",
response = ObjectDesc.class,
responseContainer = "List",
httpMethod = "GET")
Thanks!

[fehguy]

That sure looks correct to me. To debug this, could you please remove the httpMethod value?

[vvicario]

@fehguy I've removed the httpMethod value but still the same issue.

[fehguy]

Is the model an inner class? Please set debug logging for com.wordnik and paste the output.

[webron]

@vvicario - it looks like your model is an inner class (defined under an interface, but still). Since you're contributing to swaggerizing an open-source project's API, you can simply point us to the code to easy up the debugging.

In this case, I imagine the class we're looking at is https://github.com/broadinstitute/vault-boss/blob/vv_swaggerize_boss/boss-ws/src/main/java/org/genomebridge/boss/http/service/BossAPI.java#L16-L24 though I'm not certain what operation it is that you're describing. If you can provide that with that information, we can also test things locally.

And thank you for doing this - we're always happy to see open source projects adopt Swagger as their API documentation mechanism.

[vvicario]

@webron Oh, you are right it's an inner class.That might be the problem. I tested it for another class and it's working. So, is there a way to use responseContainer for inner classes? Or should I extract the inner class?

Thank you very much for your time!

[fehguy]

Is it a static public class? Or package private?

[vvicario]

public static class

[fehguy]

This could be a classloader issue. Is it in the same library as your resource app? You're not using OSGi by chance?

[vvicario]

We are not currently using OSGi, I'll try to find the classloader issue. Thank you very much for your help :)

[kinetifex]

I'm running into this exact same issue, using inner public static class for responses with responseContainer = "List". Is there a solution besides extracting inner classes?

[webron]

@vvicario - any updates?

[vvicario]

The only way i found was extracting inner classes. Regards.