Host Multiple Swagger endpoints for the same application

[dd...@appneta.com]

Hi,

We are planning to use swagger ui to document our REST apis.

One of the problems we are facing currently is that we have multiple versions of the API hosted in different folders/packages. For example /v1, /v2 and /internal which are not public facing. It is possible to host swagger in a fashion such that each swagger endpoint only documents endpoints under a certain folder.

For example 

/v1/swagger  -> Documents all REST endpoints under /v1

/internal/swagger -> Documents all REST endpoints under /internal.

The application is currently using swagger-jersey2-jaxrs_2.10 : 1.3.x

Any help in this regard would be appreciated.

Thanks,

Debojit

P.S : I was trying to use ReflectiveJaxrsScanner to choose the resource packages to scan but that keeps reporting all the REST endpoints in the project rather than the ones under the selected package.

[Ron Ratovsky]

Hi Debojit,

Using 1.3.X, it's not possible to separate the calls as you're trying.

1.5.X allows it, although it would require some work.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

[deboj...@gmail.com]

Thanks Ron for your suggestion! I will upgrade to 1.5.X and give it a try. 

Could you point me to any sample/ documentation that explains how to achieve this?

Thanks,

Debojit

[Ron Ratovsky]

The upgrade itself or hosting multiple endpoints?

[deboj...@gmail.com]

Regarding hosting multiple endpoints

[Ron Ratovsky]

No, there's no documentation for it unfortunately.

[deboj...@gmail.com]

Thanks, I will try it out myself. 

[dd...@appneta.com]

Hi Ron,

I have upgraded to swagger-jersey2-jaxrs:1.5.0 and also downloaded the latest swagger-ui to render the new spec.However, when I try to load the json file, it gets stuck at "fetching resource .." with a js error "Uncaught TypeError: Cannot read property 'parameters' of null" - I have removed all my code to create a simplest json - yet it still fails. The ui is able to render the petstore sample project properly. Could you please help me with this?
 I have attached the json with this.

[dd...@appneta.com]

I have also tried porting a the PetStore resource from the samples into my project - event that fails with a separate error  - "Uncaught RangeError: Maximum call stack size exceeded" I am also attaching the json file for this 

[Ron Ratovsky]

Looks like you've missed the SwaggerSerializers provider.

[Debojit Dhar]

Hi Ron,

Thanks for your response. Following the example here - https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5, I was using package scanning. So, the entry in my web.xml looks like below - and I use bootstrap with BeanConfig - do you think I should be adding the SwaggerSerializers  provider seperately.

      <init-param>
            <param-name>jersey.config.server.provider.packages</param-name>
            <param-value>
                io.swagger.jaxrs.listing,
                {your.application.packages}
            </param-value>
        </init-param>

[Ron Ratovsky]

Sorry for the delay. Since it's been a while, let's see.

Do you still experience the issue?

Can you share the swagger-related dependencies from your pom.xml?

[Debojit Dhar]

Hi Ron,

Actually it worked with your advice. The package scanner along was
having problem. However, when I include the resources separately in my
Application class, it seems to work.

Thanks,
Debojit

[Ron Ratovsky]

Great, thanks the update.