Package org.apache.juneau.rest.swagger

Class BasicSwaggerProviderSession

java.lang.Object

org.apache.juneau.rest.swagger.BasicSwaggerProviderSession

public class BasicSwaggerProviderSession
extends Object

A single session of generating a Swagger document.

See Also:

• juneau-bean-swagger-v2

Constructor Summary

Constructors

Constructor	Description
BasicSwaggerProviderSession(RestContext context, Locale locale, FileFinder ff, Messages messages, VarResolverSession vr, JsonSchemaGeneratorSession js)	Constructor.

Method Summary

Modifier and Type	Method	Description
Swagger	getSwagger()	Generates the swagger.

Methods inherited from class java.lang.Object

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

Constructor Details

BasicSwaggerProviderSession

public BasicSwaggerProviderSession(RestContext context,
 Locale locale,
 FileFinder ff,
 Messages messages,
 VarResolverSession vr,
 JsonSchemaGeneratorSession js)

Constructor.

Parameters:

context - The context of the REST object we're generating Swagger about.

locale - The language of the swagger we're asking for.

ff - The file finder to use for finding JSON files.

messages - The messages to use for finding localized strings.

vr - The variable resolver to use for resolving variables in the swagger.

js - The JSON-schema generator to use for stuff like examples.

Method Details

getSwagger

public Swagger getSwagger()
                   throws Exception

Generates the swagger.

Returns:

A new Swagger object.

Throws:

Exception - If an error occurred producing the Swagger.