Package com.yahoo.elide.swagger.resources

Class DocEndpoint

java.lang.Object

com.yahoo.elide.swagger.resources.DocEndpoint

@Path("/doc")
@Produces("application/json")
public class DocEndpoint
extends Object

A convenience endpoint to expose a swagger document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocEndpoint.SwaggerRegistration

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<org.apache.commons.lang3.tuple.Pair<String,String>,String>	documents

Constructor Summary

Constructors

Constructor	Description
DocEndpoint(List<DocEndpoint.SwaggerRegistration> docs)	Constructs the resource.

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	get(String apiVersion, String name)	Read handler.
javax.ws.rs.core.Response	list(String apiVersion)

Methods inherited from class java.lang.Object

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

Field Detail

documents

protected Map<org.apache.commons.lang3.tuple.Pair<String,String>,String> documents

Constructor Detail

DocEndpoint

@Inject
public DocEndpoint(@Named("swagger")
                   List<DocEndpoint.SwaggerRegistration> docs)

Constructs the resource.

Parameters:

docs - Map of path parameter name to swagger document.

Method Detail

list

@GET
@Path("/")
public javax.ws.rs.core.Response list(@HeaderParam("ApiVersion")
                                      String apiVersion)

get

@GET
@Path("/{name}")
public javax.ws.rs.core.Response get(@HeaderParam("ApiVersion")
                                     String apiVersion,
                                     @PathParam("name")
                                     String name)

Read handler.

Parameters:

name - document name

Returns:

response The Swagger JSON document