com.cerner.beadledom.swagger

Class SwaggerApiResource

java.lang.Object

com.wordnik.swagger.jaxrs.listing.ApiListingResource

com.wordnik.swagger.jaxrs.listing.ApiListingResourceJSON

com.cerner.beadledom.swagger.SwaggerApiResource

@Path(value="/api-docs")
public class SwaggerApiResource
extends com.wordnik.swagger.jaxrs.listing.ApiListingResourceJSON

This alters the responses of Swagger's ApiListingResourceJSON class so that the basePath field will be set.

Normally you must set the basePath globally on the SwaggerConfig, but doing it like this allows us to retrieve the path from the UriInfo rather than explicitly configuring it.

If the basePath is already set this class will not alter it.

Constructor Summary

Constructors

Constructor and Description
SwaggerApiResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	apiDeclaration(String route, javax.ws.rs.core.Application app, javax.servlet.ServletConfig sc, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo) Serves the Swagger API.

Methods inherited from class com.wordnik.swagger.jaxrs.listing.ApiListingResource

cleanRoute, com$wordnik$swagger$jaxrs$listing$ApiListingResource$$LOGGER, cookiesToMap, headersToMap, invalidateCache, paramsToMap, resourceListing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwaggerApiResource

public SwaggerApiResource()

Method Detail

apiDeclaration

public javax.ws.rs.core.Response apiDeclaration(@PathParam(value="route")
                                                String route,
                                                @Context
                                                javax.ws.rs.core.Application app,
                                                @Context
                                                javax.servlet.ServletConfig sc,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)

Serves the Swagger API.

Overrides:

apiDeclaration in class com.wordnik.swagger.jaxrs.listing.ApiListingResource

Parameters:

route - the route

app - the app

sc - the service config

headers - the headers

uriInfo - the uri info

Returns:

The Swagger API document.