org.restlet.ext.raml

Class RamlSpecificationRestlet

java.lang.Object

org.restlet.Restlet

org.restlet.ext.raml.RamlSpecificationRestlet

All Implemented Interfaces:

Uniform

Deprecated.

Will be removed in next minor release.

@Deprecated
public class RamlSpecificationRestlet
extends Restlet

Restlet that generates RAML documentation in the format defined by the RAML specifications.
It helps to generate the documentation for the whole API (set by calling setApiInboundRoot(Application) or setApiInboundRoot(Restlet) methods.
By default it instrospects the chain of Application's routers, filters, restlets.

Usage example:

 RamlSpecificationRestlet ramlSpecificationRestlet = new RamlSpecificationRestlet();
 ramlSpecificationRestlet.setApiInboundRoot(this);
 ramlSpecificationRestlet.setBasePath("http://myapp.com/api/v1");
 ramlSpecificationRestlet.attach(baseRouter);
 

Author:

Cyprien Quilici

Constructor Summary

Constructors

Constructor and Description
RamlSpecificationRestlet() Deprecated. Default constructor.
RamlSpecificationRestlet(Context context) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	attach(Router router) Deprecated. Defines one route (by default "/raml") for serving the application specification.
void	attach(Router router, java.lang.String path) Deprecated. Defines one route (by default "/raml") for serving the application specification.
Restlet	getApiInboundRoot() Deprecated. Returns the root Restlet for the given application.
java.lang.String	getApiVersion() Deprecated. Returns the API's version.
java.lang.String	getBasePath() Deprecated. Returns the base path of the API.
Representation	getRaml() Deprecated. Returns the representation of the whole resource listing of the Application.
java.lang.String	getRamlVersion() Deprecated. Returns the version of RAML used to generate this documentation.
void	handle(Request request, Response response) Deprecated.
void	setApiInboundRoot(Application application) Deprecated. Sets the root Restlet for the given application.
void	setApiInboundRoot(Restlet apiInboundRoot) Deprecated. Sets the root Restlet for the given application.
void	setApiVersion(java.lang.String apiVersion) Deprecated. Sets the API's version.
void	setBasePath(java.lang.String basePath) Deprecated. Sets the base path of the API.
void	setRamlVersion(java.lang.String ramlVersion) Deprecated. Sets the version of RAML used to generate this documentation.

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlSpecificationRestlet

public RamlSpecificationRestlet()

Deprecated.

Default constructor.

RamlSpecificationRestlet

public RamlSpecificationRestlet(Context context)

Deprecated.

Constructor.

Parameters:

context - The context.

Method Detail

attach

public void attach(Router router)

Deprecated.

Defines one route (by default "/raml") for serving the application specification.

Parameters:

router - The router on which defining the new route.

See Also:

to attach it with a custom path

attach

public void attach(Router router,
                   java.lang.String path)

Deprecated.

Defines one route (by default "/raml") for serving the application specification.

Parameters:

router - The router on which defining the new route.

path - The root path of the documentation Restlet.

See Also:

to attach it with the default path

getApiInboundRoot

public Restlet getApiInboundRoot()

Deprecated.

Returns the root Restlet for the given application.

Returns:

The root Restlet for the given application.

getApiVersion

public java.lang.String getApiVersion()

Deprecated.

Returns the API's version.

Returns:

The API's version.

getBasePath

public java.lang.String getBasePath()

Deprecated.

Returns the base path of the API.

Returns:

The base path of the API.

getRaml

public Representation getRaml()

Deprecated.

Returns the representation of the whole resource listing of the Application.

Returns:

The representation of the whole resource listing of the Application.

getRamlVersion

public java.lang.String getRamlVersion()

Deprecated.

Returns the version of RAML used to generate this documentation.

Returns:

The version of RAML used to generate this documentation.

handle

public void handle(Request request,
                   Response response)

Deprecated.

Specified by:

handle in interface Uniform

Overrides:

handle in class Restlet

setApiInboundRoot

public void setApiInboundRoot(Application application)

Deprecated.

Sets the root Restlet for the given application.

Parameters:

application - The application.

setApiInboundRoot

public void setApiInboundRoot(Restlet apiInboundRoot)

Deprecated.

Sets the root Restlet for the given application.

Parameters:

apiInboundRoot - The application's root Restlet.

setApiVersion

public void setApiVersion(java.lang.String apiVersion)

Deprecated.

Sets the API's version.

Parameters:

apiVersion - The API version.

setBasePath

public void setBasePath(java.lang.String basePath)

Deprecated.

Sets the base path of the API.

Parameters:

basePath - The base path of the API

setRamlVersion

public void setRamlVersion(java.lang.String ramlVersion)

Deprecated.

Sets the version of RAML used to generate this documentation.

Parameters:

ramlVersion - The version of RAML.