org.restlet.ext.swagger

Class Swagger2SpecificationRestlet

java.lang.Object

org.restlet.Restlet

org.restlet.ext.swagger.Swagger2SpecificationRestlet

All Implemented Interfaces:

Uniform

Deprecated.

Will be replaced by an OAS extension in 2.5 release.

@Deprecated
public class Swagger2SpecificationRestlet
extends Restlet

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

Usage example (in an Application class):

 new Swagger2SpecificationRestlet(this).attach(baseRouter);
 

or

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

Author:

Manuel Boillod

See Also:

Swagger UI (github), Petstore sample application of Swagger-UI, Swagger.io website

Constructor Summary

Constructors

Constructor and Description
Swagger2SpecificationRestlet(Application application) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	attach(Router router) Deprecated. Defines one route (by default "/swagger.json") for serving the application specification.
void	attach(Router router, java.lang.String path) Deprecated. Defines one route (by default "/swagger.json") for serving the application specification.
java.lang.String	getApiVersion() Deprecated. Returns the API's version.
java.lang.String	getBasePath() Deprecated. Returns the base path of the API.
Representation	getSwagger() 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	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

Swagger2SpecificationRestlet

public Swagger2SpecificationRestlet(Application application)

Deprecated.

Constructor.

Parameters:

application - The application to describe.

Method Detail

attach

public void attach(Router router)

Deprecated.

Defines one route (by default "/swagger.json") 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 "/swagger.json") 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

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.

getSwagger

public Representation getSwagger()

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 Swagger2Writer.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

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.