ApiListingResource (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.rest.resources.ApiListingResource

Direct Known Subclasses:

ApidocResource
```
public class ApiListingResource
extends java.lang.Object
```
ApiListingResource usable within a jersey servlet filter. Taken from io.swagger:swagger-jaxrs, class io.swagger.jaxrs.listing.ApiListingResource, which can only be used within a servlet context. We are here using a filter, but jersey has a WebConfig class that can substitute ServletConfig and FilterConfig.

Constructor Summary

Constructors
Constructor and Description

ApiListingResource()

Constructors
Constructor and Description
`ApiListingResource()`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`getListing(javax.ws.rs.core.Application app, WebConfig sc, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, java.lang.String type)`
`javax.ws.rs.core.Response`	`getListingJson(javax.ws.rs.core.Application app, WebConfig sc, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`getListingYaml(javax.ws.rs.core.Application app, WebConfig sc, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ApiListingResource
```
public ApiListingResource()
```

Method Detail

getListing

@GET
@Produces(value={"application/json","application/yaml"})
@Path(value="/swagger.{type:json|yaml}")
public javax.ws.rs.core.Response getListing(@Context
                                                     javax.ws.rs.core.Application app,
                                                     @Context
                                                     WebConfig sc,
                                                     @Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     @PathParam(value="type")
                                                     java.lang.String type)

getListingJson

@GET
@Produces(value="application/json")
@Path(value="/swagger")
public javax.ws.rs.core.Response getListingJson(@Context
                                                         javax.ws.rs.core.Application app,
                                                         @Context
                                                         WebConfig sc,
                                                         @Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @Context
                                                         javax.ws.rs.core.UriInfo uriInfo)

getListingYaml

@GET
@Produces(value="application/yaml")
@Path(value="/swagger")
public javax.ws.rs.core.Response getListingYaml(@Context
                                                         javax.ws.rs.core.Application app,
                                                         @Context
                                                         WebConfig sc,
                                                         @Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @Context
                                                         javax.ws.rs.core.UriInfo uriInfo)

Class ApiListingResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiListingResource

Method Detail

getListing

getListingJson

getListingYaml