Package org.apache.juneau.rest.swagger

Interface SwaggerProvider

All Known Implementing Classes:

BasicSwaggerProvider, SwaggerProvider.Void

public interface SwaggerProvider

Interface for retrieving Swagger on a REST resource.

See Also:

• Swagger

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SwaggerProvider.Builder	Builder class.
static class	SwaggerProvider.Void	Represents no SwaggerProvider.

Method Summary

Modifier and Type	Method	Description
static SwaggerProvider.Builder	create(BeanStore beanStore)	Static creator.
Swagger	getSwagger(RestContext context, Locale locale)	Returns the Swagger associated with the specified Rest-annotated class.

Method Details

create

static SwaggerProvider.Builder create(BeanStore beanStore)

Static creator.

Parameters:

beanStore - The bean store to use for creating beans.

Returns:

A new builder for this object.

getSwagger

Swagger getSwagger(RestContext context,
 Locale locale)
            throws Exception

Returns the Swagger associated with the specified Rest-annotated class.

Parameters:

context - The context of the Rest-annotated class.

locale - The request locale.

Returns:

A new Swagger DTO object.

Throws:

Exception - If an error occurred producing the Swagger.