restx.apidocs

Class ApiDocsIndexRoute

java.lang.Object

restx.StdRoute

restx.entity.StdEntityRoute<Void,O>

restx.jackson.StdJsonProducerEntityRoute

restx.apidocs.ApiDocsIndexRoute

All Implemented Interfaces:

DescribableRoute, RestxHandler, RestxHandlerMatcher, RestxRoute

public class ApiDocsIndexRoute
extends StdJsonProducerEntityRoute

Serves the swagger resource listing, which looks like that: { "apiVersion":"0.2", "swaggerVersion":"1.1", "basePath":"http://petstore.swagger.wordnik.com/api", "apis":[ { "path":"/api-docs.{format}/user", "description":"" }, { "path":"/api-docs.{format}/pet", "description":"" } ] }

Nested Class Summary

Nested classes/interfaces inherited from class restx.entity.StdEntityRoute

StdEntityRoute.Builder<I,O>

Field Summary

Fields inherited from class restx.entity.StdEntityRoute

EMPTY_COLLECTION_SUPPLIER, EMPTY_ITERABLE_SUPPLIER, EMPTY_LIST_SUPPLIER, EMPTY_SET_SUPPLIER

Constructor Summary

Constructors

Constructor and Description
ApiDocsIndexRoute(com.fasterxml.jackson.databind.ObjectWriter writer, Factory factory, RestxSecurityManager securityManager, PermissionFactory permissionFactory, EndpointParameterMapperRegistry registry)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.base.Optional<?>	doRoute(RestxRequest restxRequest, RestxResponse response, RestxRequestMatch match, Object i)

Methods inherited from class restx.entity.StdEntityRoute

allOf, anyOf, builder, getEntityRequestBodyType, getEntityResponseType, handle, hasRole, isAuthenticated, mapQueryObjectFromRequest, mapQueryObjectFromRequest, open

Methods inherited from class restx.StdRoute

describe, describeOperation, getMatcher, getSuccessStatus, match, notFound, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDocsIndexRoute

@Inject
public ApiDocsIndexRoute(@Named(value="FrontObjectWriter")
                                 com.fasterxml.jackson.databind.ObjectWriter writer,
                                 Factory factory,
                                 RestxSecurityManager securityManager,
                                 PermissionFactory permissionFactory,
                                 EndpointParameterMapperRegistry registry)

Method Detail

doRoute

protected com.google.common.base.Optional<?> doRoute(RestxRequest restxRequest,
                                                     RestxResponse response,
                                                     RestxRequestMatch match,
                                                     Object i)
                                              throws IOException

Specified by:

doRoute in class StdEntityRoute

Throws:

IOException