Package org.restlet.ext.swagger

Integration with Wordnik Swagger 1.5.

See: Description

Class Summary

Class	Description
JaxRsApplicationSwagger2SpecificationRestlet	Restlet that generates Swagger documentation in the format defined by the swagger-spec project 2.0 for a JaxRS application It helps to generate the high level documentation for the whole API (set by calling JaxRsApplicationSwagger2SpecificationRestlet.setApplication(Application) methods, and the documentation for each resource. By default it instrospects the JaxRs Application classes and singletons. Use the SwaggerSpecificationRestlet restlet for Restlet applications.
JaxRsApplicationSwaggerSpecificationRestlet	Restlet that generates Swagger documentation in the format defined by the swagger-spec project for a JaxRS application It helps to generate the high level documentation for the whole API (set by calling JaxRsApplicationSwaggerSpecificationRestlet.setApplication(Application) or JaxRsApplicationSwaggerSpecificationRestlet.setApiInboundRoot(Application) methods, and the documentation for each resource. By default it instrospects the JaxRs Application classes and singletons. Use the SwaggerSpecificationRestlet restlet for Restlet applications.
Swagger2SpecificationRestlet	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 Swagger2SpecificationRestlet.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.
SwaggerApplication	Swagger enabled application.
SwaggerSpecificationRestlet	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 SwaggerSpecificationRestlet.setApplication(Application) or SwaggerSpecificationRestlet.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.

Package org.restlet.ext.swagger Description

Integration with Wordnik Swagger 1.5. Swagger is a description framework that lets you document your web API. This extension can generate the JSON description document following the Swagger format, which can be consumed by the Swagger HTML/JS user interface.

Since:

Restlet 2.2

See Also:

Swagger framework, User Guide - Swagger extension