Package com.peterphi.std.guice.web.rest.service.servicedescription

Interface RestServiceList

All Known Implementing Classes:

RestServiceListImpl

@Path("/guice")
public interface RestServiceList

Method Summary

Modifier and Type	Method	Description
String	getExampleXML(String className, boolean minimal)
String	getServiceDescription(int serviceId, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
String	getXSDSchema(String className)
String	index(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)

Method Details

index

@GET
@Produces("text/html")
@Path("/")
String index(@Context
 javax.ws.rs.core.HttpHeaders headers,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
      throws Exception

Throws:

Exception

getServiceDescription

@GET
@Produces("text/html")
@Path("/service/{service_id}")
String getServiceDescription(@PathParam("service_id")
 int serviceId,
 @Context
 javax.ws.rs.core.HttpHeaders headers,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                      throws Exception

Throws:

Exception

getXSDSchema

@GET
@Produces("text/xml")
@Path("/type/{class}/schema.xsd")
String getXSDSchema(@PathParam("class")
 String className)
             throws Exception

Throws:

Exception

getExampleXML

@GET
@Produces("text/xml")
@Path("/type/{class}/example.xml")
String getExampleXML(@PathParam("class")
 String className,
 @QueryParam("minimal") @DefaultValue("false")
 boolean minimal)
              throws Exception

Throws:

Exception