restx.apidocs

Class ApiDeclarationRoute

java.lang.Object

restx.StdRoute

restx.entity.StdEntityRoute<Void,O>

restx.jackson.StdJsonProducerEntityRoute

restx.apidocs.ApiDeclarationRoute

All Implemented Interfaces:

DescribableRoute, RestxHandler, RestxHandlerMatcher, RestxRoute

public class ApiDeclarationRoute
extends StdJsonProducerEntityRoute

Serves the swagger api declaration of one router, which looks like that:

 {
   apiVersion: "0.2",
   swaggerVersion: "1.1",
   basePath: "http://petstore.swagger.wordnik.com/api",
   resourcePath: "/pet.{format}"

   ...

   apis: [...]
   models: {...}
 }
 

See API Declaration

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
ApiDeclarationRoute(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 body)

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

ApiDeclarationRoute

@Inject
public ApiDeclarationRoute(@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 body)
                                              throws IOException

Specified by:

doRoute in class StdEntityRoute

Throws:

IOException