water.api

Interface RestApiContext

All Known Implementing Classes:

RequestServer.DummyRestApiContext

public interface RestApiContext

REST API registration interfaces. This is an abstraction layer between a rest server and registration modules.

Method Summary

Modifier and Type	Method and Description
Route	registerEndpoint(java.lang.String methodUri, java.lang.Class<? extends RestApiHandler> handlerClass)
Route	registerEndpoint(java.lang.String apiName, java.lang.String methodUri, java.lang.Class<? extends Handler> handlerClass, java.lang.String handlerMethod, java.lang.String summary)
Route	registerEndpoint(java.lang.String apiName, java.lang.String httpMethod, java.lang.String url, java.lang.Class<? extends Handler> handlerClass, java.lang.String handlerMethod, java.lang.String summary, HandlerFactory handlerFactory)
void	registerSchema(Schema... schemas)

Method Detail

registerEndpoint

Route registerEndpoint(java.lang.String apiName,
                       java.lang.String methodUri,
                       java.lang.Class<? extends Handler> handlerClass,
                       java.lang.String handlerMethod,
                       java.lang.String summary)

registerEndpoint

Route registerEndpoint(java.lang.String apiName,
                       java.lang.String httpMethod,
                       java.lang.String url,
                       java.lang.Class<? extends Handler> handlerClass,
                       java.lang.String handlerMethod,
                       java.lang.String summary,
                       HandlerFactory handlerFactory)

registerEndpoint

Route registerEndpoint(java.lang.String methodUri,
                       java.lang.Class<? extends RestApiHandler> handlerClass)

registerSchema

void registerSchema(Schema... schemas)