org.restlet.ext.swagger

Class SwaggerSpecificationRestlet

java.lang.Object

org.restlet.Restlet

org.restlet.ext.swagger.SwaggerSpecificationRestlet

All Implemented Interfaces:

Uniform

Deprecated.

Will be replaced by an OAS extension in 2.5 release.

@Deprecated
public class SwaggerSpecificationRestlet
extends Restlet

Restlet that generates Swagger documentation in the format defined by the swagger-spec project.
It helps to generate the high level documentation for the whole API (set by calling setApplication(Application) or setApiInboundRoot(Application) methods, and the documentation for each resource.
By default it instrospects the chain of Application's routers, filters, restlet.
Use the JaxRsApplicationSwaggerSpecificationRestlet restlet for Jax-RS applications.

Usage example:

 // this is the current Application
 SwaggerSpecificationRestlet swaggerSpecificationRestlet = new SwaggerSpecificationRestlet(this);
 swaggerSpecificationRestlet.setBasePath("http://myapp.com/api/v1");
 swaggerSpecificationRestlet.attach(baseRouter);
 

Author:

Thierry Boileau

See Also:

Swagger UI (github), Petstore sample application of Swagger-UI, Swagger Developper page

Constructor Summary

Constructors

Constructor and Description
SwaggerSpecificationRestlet() Deprecated. Default constructor.
SwaggerSpecificationRestlet(Application application) Deprecated. Constructor.
SwaggerSpecificationRestlet(Context context) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	attach(Router router) Deprecated. Defines two routes, one for the high level "Resource listing" (by default "/api-docs"), and the other one for the "API declaration".
void	attach(Router router, java.lang.String path) Deprecated. Defines two routes, one for the high level "Resource listing", and the other one for the "API declaration".
Representation	getApiDeclaration(java.lang.String category) Deprecated. Returns the Swagger documentation of a given resource, also known as "API Declaration" in Swagger vocabulary.
java.lang.String	getApiVersion() Deprecated. Returns the API's version.
java.lang.String	getBasePath() Deprecated. Returns the base path of the API.
Representation	getResourceListing() Deprecated. Returns the representation of the whole resource listing of the Application.
java.lang.String	getSwaggerVersion() Deprecated. Returns the version of the Swagger specification.
void	handle(Request request, Response response) Deprecated.
void	setApiInboundRoot(Application application) Deprecated. Sets the root Restlet for the given application.
void	setApiVersion(java.lang.String apiVersion) Deprecated. Sets the API's version.
void	setApplication(Application application) Deprecated. Sets the root Restlet for the given application.
void	setBasePath(java.lang.String basePath) Deprecated. Sets the base path of the API.
void	setSwaggerVersion(java.lang.String swaggerVersion) Deprecated. Sets the version of the Swagger specification.

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

SwaggerSpecificationRestlet

public SwaggerSpecificationRestlet()

Deprecated.

Default constructor.

SwaggerSpecificationRestlet

public SwaggerSpecificationRestlet(Application application)

Deprecated.

Constructor.

Parameters:

application - The application to describe.

SwaggerSpecificationRestlet

public SwaggerSpecificationRestlet(Context context)

Deprecated.

Constructor.

Parameters:

context - The context.

Method Detail

attach

public void attach(Router router)

Deprecated.

Defines two routes, one for the high level "Resource listing" (by default "/api-docs"), and the other one for the "API declaration". The second route is a sub-resource of the first one, defined with the path variable "resource" (ie "/api-docs/{resource}").

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 two routes, one for the high level "Resource listing", and the other one for the "API declaration". The second route is a sub-resource of the first one, defined with the path variable "resource".

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

getApiDeclaration

public Representation getApiDeclaration(java.lang.String category)

Deprecated.

Returns the Swagger documentation of a given resource, also known as "API Declaration" in Swagger vocabulary.

Parameters:

category - The category of the resource to describe.

Returns:

The representation of the API declaration.

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.

getResourceListing

public Representation getResourceListing()

Deprecated.

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

Returns:

The representation of the whole resource listing of the Application.

getSwaggerVersion

public java.lang.String getSwaggerVersion()

Deprecated.

Returns the version of the Swagger specification. Default is SwaggerWriter.SWAGGER_VERSION

Returns:

The version of the Swagger specification.

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.

setApiVersion

public void setApiVersion(java.lang.String apiVersion)

Deprecated.

Sets the API's version.

Parameters:

apiVersion - The API version.

setApplication

public void setApplication(Application application)

Deprecated.

Sets the root Restlet for the given application.

Parameters:

application - The application.

setBasePath

public void setBasePath(java.lang.String basePath)

Deprecated.

Sets the base path of the API.

Parameters:

basePath - The base path of the API

setSwaggerVersion

public void setSwaggerVersion(java.lang.String swaggerVersion)

Deprecated.

Sets the version of the Swagger specification.

Parameters:

swaggerVersion - The version of the Swagger specification.