ApidocResource (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

brooklyn.rest.apidoc
[Java] Class ApidocResource

java.lang.Object
  brooklyn.rest.apidoc.ApidocResource

@Produces({"application/json"})
/** like Swagger ApiListing (and based on that) but:
 * supports singletons as well as classes;
 * supports simpler Apidoc annotation (doesn't repeat path, in common case);
 * doesn't support listingPath/Class that swagger does (but describes in under /apidoc/name.of.Class
 * does not support auth filters
 */
public abstract class ApidocResource

like Swagger ApiListing (and based on that) but: supports singletons as well as classes; supports simpler Apidoc annotation (doesn't repeat path, in common case); doesn't support listingPath/Class that swagger does (but describes in under /apidoc/name.of.Class does not support auth filters

Field Summary
`protected static java.util.Map`	`endpointsCache`

Method Summary
`Response`	`details(ResourceConfig rc, HttpHeaders headers, UriInfo uriInfo, java.lang.String resource)`
`Response`	`getAllApis(ResourceConfig rc, HttpHeaders headers, UriInfo uriInfo)`
`protected ConfigReader`	`getConfigReader()`
`protected java.lang.String`	`getLinkFor(java.lang.String path, java.lang.Class resource)`
`protected java.lang.String`	`getLinkWordFor(java.lang.Class resource)`
`protected java.util.Set`	`getResourceClasses(ResourceConfig rc)`
`protected java.lang.Class`	`getResourceOfLink(ResourceConfig rc, java.lang.String link)`
`protected boolean`	`isIncludedForDocumentation(java.lang.Class resource)`
`protected boolean`	`isSupportedMediaType(java.lang.String type)`
`protected Documentation`	`read(java.lang.Class target, java.lang.String apiVersion, java.lang.String swaggerVersion, java.lang.String basePath, java.lang.String apiPath)`

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Field Detail

endpointsCache

protected static java.util.Map endpointsCache

Method Detail

details

@GET
@Path("/{resource}")
public Response details(@Context ResourceConfig rc, @Context HttpHeaders headers, @Context UriInfo uriInfo, @PathParam("resource") java.lang.String resource)

getAllApis

@GET
@ApiOperation(value = "Returns list of all available API resource endpoints", responseClass = "DocumentationEndPoint", multiValueResponse = true)
public Response getAllApis(@Context ResourceConfig rc, @Context HttpHeaders headers, @Context UriInfo uriInfo)

getConfigReader

protected ConfigReader getConfigReader()

getLinkFor

protected java.lang.String getLinkFor(java.lang.String path, java.lang.Class resource)

getLinkWordFor

protected java.lang.String getLinkWordFor(java.lang.Class resource)

getResourceClasses

protected java.util.Set getResourceClasses(ResourceConfig rc)

getResourceOfLink

protected java.lang.Class getResourceOfLink(ResourceConfig rc, java.lang.String link)

isIncludedForDocumentation

protected boolean isIncludedForDocumentation(java.lang.Class resource)

isSupportedMediaType

protected boolean isSupportedMediaType(java.lang.String type)

read

protected Documentation read(java.lang.Class target, java.lang.String apiVersion, java.lang.String swaggerVersion, java.lang.String basePath, java.lang.String apiPath)

brooklyn.rest.apidoc [Java] Class ApidocResource