org.restlet.ext.swagger

Class SwaggerApplication

java.lang.Object

org.restlet.Restlet

org.restlet.Application

org.restlet.ext.swagger.SwaggerApplication

All Implemented Interfaces:

org.restlet.ext.platform.internal.introspection.DocumentedApplication, Uniform

Deprecated.

Will be replaced by an OAS extension in 2.5 release.

@Deprecated
public class SwaggerApplication
extends Application
implements org.restlet.ext.platform.internal.introspection.DocumentedApplication

Swagger enabled application. This subclass of Application can describe itself in the format described by the Swagger specification project.

It requires you to set up a specific end point that serves the resource listing and a sub-resource that serves the API declaration of a specific resource.

By default, nothing is required. This application adds to its inbound root the endpoints ("/api-docs", and "/api-docs/{resource}") required by Swagger specification. You can override this behavior by using the SwaggerApplication#attachSwagger* methods
By default, both descriptions are generated by introspecting the application itself. You can override this behavior by specifying your own implementation of SwaggerSpecificationRestlet.

Author:

Thierry Boileau

See Also:

SwaggerSpecificationRestlet, Swagger2SpecificationRestlet

Constructor Summary

Constructors

Constructor and Description
SwaggerApplication() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	attachSwaggerDocumentationRestlets(Router router, java.lang.String resourceListingPath, Restlet resourceListingRestlet, java.lang.String apiDeclarationPath, Restlet apiDeclarationRestlet) Deprecated. Defines two routes, one for the high level "Resource listing", and the other one for the "API declaration".
void	attachSwaggerSpecificationRestlet(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	attachSwaggerSpecificationRestlet(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".
Restlet	getInboundRoot() Deprecated. Overrides the parent's implementation.
java.util.Map<java.lang.String,org.restlet.ext.platform.internal.model.Section>	getSections() Deprecated. The sections of the Web API.
SwaggerSpecificationRestlet	getSwaggerSpecificationRestlet(Context context) Deprecated. The dedicated Restlet able to generate the Swagger specification formats.

Methods inherited from class org.restlet.Application

createInboundRoot, createOutboundRoot, getConnectorService, getConnegService, getConverterService, getCurrent, getDecoderService, getEncoderService, getMetadataService, getOutboundRoot, getRangeService, getRole, getRoles, getServices, getStatusService, getTaskService, getTunnelService, handle, isDebugging, setConnectorService, setConnegService, setContext, setConverterService, setCurrent, setDebugging, setDecoderService, setEncoderService, setInboundRoot, setInboundRoot, setMetadataService, setOutboundRoot, setOutboundRoot, setRangeService, setRoles, setStatusService, setTaskService, setTunnelService, start, stop

Methods inherited from class org.restlet.Restlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerApplication

public SwaggerApplication()

Deprecated.

Method Detail

attachSwaggerDocumentationRestlets

public void attachSwaggerDocumentationRestlets(Router router,
                                               java.lang.String resourceListingPath,
                                               Restlet resourceListingRestlet,
                                               java.lang.String apiDeclarationPath,
                                               Restlet apiDeclarationRestlet)

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.

resourceListingPath - The path to which attach the Restlet that serves the resource listing.

resourceListingRestlet - The Restlet that serves the resource listing.

apiDeclarationPath - The path to which attach the Restlet that serves the declaration of a specific resource.

apiDeclarationRestlet - The Restlet that serves the declaration of a specific resource.

attachSwaggerSpecificationRestlet

public void attachSwaggerSpecificationRestlet(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

attachSwaggerSpecificationRestlet

public void attachSwaggerSpecificationRestlet(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

getInboundRoot

public Restlet getInboundRoot()

Deprecated.

Overrides the parent's implementation. It checks that the application has been documented using a SwaggerSpecificationRestlet. By default, the documentation is attached to the high level router, with the "/api-docs" path.

Overrides:

getInboundRoot in class Application

getSections

public java.util.Map<java.lang.String,org.restlet.ext.platform.internal.model.Section> getSections()

Deprecated.

Description copied from interface: org.restlet.ext.platform.internal.introspection.DocumentedApplication

The sections of the Web API. The key of the map is the section name and the value is the optional description.

Specified by:

getSections in interface org.restlet.ext.platform.internal.introspection.DocumentedApplication

Returns:

The sections of the Web API.

getSwaggerSpecificationRestlet

public SwaggerSpecificationRestlet getSwaggerSpecificationRestlet(Context context)

Deprecated.

The dedicated Restlet able to generate the Swagger specification formats.

Returns:

The Restlet able to generate the Swagger specification formats.