Swagger with (Apache Camel) CXFRS

[lekkie omotayo]

Hi all,

I am trying to integrate Swagger with Camel-cxfrs

I saw this which I implemented but it didnt work. Camel-cxfrs does not use web.xml to expose REST service as such it doesnt load web.xml even though I added the file as described in the sample in the URL above.

I will appreciate any help.

Regards.

[tony tam]

The cxf example you linked to has a special injection of the @application context, which makes the swagger integration work.  You don't need a web.xml, but you do need something to bootstrap the system.

[lekkie omotayo]

I looked through the files and didn't see any @application injected at any point in the java classes. Would you be magnanimous enough to point out which Java class was annotated?

When you say bootstrap, you mean I need something to initialize and expose the REST service? If that is the case, the Camel CXFRS already does that by itself? If you mean something else, I will appreciate if you can further explain.

Regards.

[tony tam]

Hi, see here:

https://github.com/wordnik/swagger-core/blob/master/samples/java-jaxrs-cxf/src/main/resources/applicationContext.xml#L67

<property name="application" ref="basicApplication" />

Will add the application into the context so swagger can read the referenced classes through this reader:

https://github.com/wordnik/swagger-core/blob/master/samples/java-jaxrs-cxf/src/main/java/com/wordnik/swagger/sample/util/BasicApplication.java

If you look in how the resource listing is generated, it's just like any other JAX-RS resource.  So you simply need to tell the camel framework that it's available, and should be processed & exposed:

https://github.com/wordnik/swagger-core/blob/master/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/listing/ApiListingResource.scala

and

https://github.com/wordnik/swagger-core/blob/master/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/listing/ApiListing.scala#L51

[lekkie omotayo]

Hi Tony,

I found a way to bootstrap the application and yet no lock:

<cxf:rsServer id="restv1Service"

address="${services.rest.url.prefix}/api/v1/service"

staticSubresourceResolution="true" >

<cxf:serviceBeans>

<ref bean="restRequestResourceBean" />

<ref bean="swaggerResourceJSON" />

<ref bean="swaggerResourceXML" />

</cxf:serviceBeans>

<cxf:extensionMappings>

<entry key="json" value="application/json" />

<entry key="xml" value="application/xml" />

</cxf:extensionMappings>

<cxf:providers>

<ref bean="jsonProvider" />

<ref bean="jaxbProvider" />

<ref bean="securityContext" />

</cxf:providers>

<cxf:properties> 

<entry key="application" value-ref="basicApplication"/> 

</cxf:properties>

<cxf:outInterceptors>

<ref bean="loggingOutInterceptor"/>

</cxf:outInterceptors>

<cxf:inInterceptors>

<ref bean="loggingInInterceptor"/>

</cxf:inInterceptors>

</cxf:rsServer>

I am wondering, the swagger documentation mentioned the swagger.api.basepath, swagger.version, and api.version are important. If you therefore claim that the web.xml isnt important or useful, how will Swager be able to get these values?

I am still not able to expose my REST API with swagger. I will appreciate whatever help you can give.