Package org.apache.juneau.rest.server.swagger

Class BasicSwaggerProvider

java.lang.Object

org.apache.juneau.rest.server.swagger.BasicSwaggerProvider

All Implemented Interfaces:

SwaggerProvider

public class BasicSwaggerProvider
extends Object
implements SwaggerProvider

Basic implementation of a SwaggerProvider.

See Also:

• juneau-bean-swagger-v2

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.rest.server.swagger.SwaggerProvider

SwaggerProvider.Builder, SwaggerProvider.Void

Constructor Summary

Constructors

Constructor	Description
BasicSwaggerProvider(BeanStore beanStore)	Constructor.
BasicSwaggerProvider(SwaggerProvider.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
Swagger	getSwagger(RestContext context, Locale locale)	Returns the Swagger associated with the specified context of a Rest-annotated class.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicSwaggerProvider

public BasicSwaggerProvider(BeanStore beanStore)

Constructor.

Parameters:

beanStore - The bean store containing injectable beans for this Swagger provider.
Must not be null.

BasicSwaggerProvider

public BasicSwaggerProvider(SwaggerProvider.Builder builder)

Constructor.

Parameters:

builder - The builder containing the settings for this Swagger provider.
Must not be null.

Method Details

getSwagger

public Swagger getSwagger(RestContext context,
 Locale locale)
                   throws Exception

Returns the Swagger associated with the specified context of a Rest-annotated class.

Subclasses can override this to provide their own method for generating Swagger.

Specified by:

getSwagger in interface SwaggerProvider

Parameters:

context - The context of the Rest-annotated class.

locale - The request locale.

Returns:

A new Swagger object.

Throws:

Exception - If an error occurred producing the Swagger.