restx.apidocs

Class ApiDeclarationRoute

java.lang.Object

restx.StdRoute

restx.StdEntityRoute

restx.apidocs.ApiDeclarationRoute

All Implemented Interfaces:

DescribableRoute, RestxHandler, RestxRoute

public class ApiDeclarationRoute
extends StdEntityRoute

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

Field Summary

Fields inherited from class restx.StdEntityRoute

mapper

Constructor Summary

Constructors

Constructor and Description
ApiDeclarationRoute(com.fasterxml.jackson.databind.ObjectMapper mapper, Factory factory)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.google.common.base.Optional<?>	doRoute(RestxRequest restxRequest, RestxRouteMatch match)

Methods inherited from class restx.StdEntityRoute

getObjectWriter, handle, writeValue

Methods inherited from class restx.StdRoute

describe, describeOperation, 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="FrontObjectMapper")
                          com.fasterxml.jackson.databind.ObjectMapper mapper,
                          Factory factory)

Method Detail

doRoute

protected com.google.common.base.Optional<?> doRoute(RestxRequest restxRequest,
                                         RestxRouteMatch match)
                                              throws IOException

Specified by:

doRoute in class StdEntityRoute

Throws:

IOException