org.apache.juneau.dto.swagger.ui

Class SwaggerUI

java.lang.Object

org.apache.juneau.transform.PojoSwap<Swagger,Div>

org.apache.juneau.dto.swagger.ui.SwaggerUI

public class SwaggerUI
extends PojoSwap<Swagger,Div>

Generates a Swagger-UI interface from a Swagger document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SWAGGERUI_resolveRefsMaxDepth Configuration property: Resolve $ref references in schema up to the specified depth.

Fields inherited from class org.apache.juneau.transform.PojoSwap

NULL

Constructor Summary

Constructors

Constructor and Description
SwaggerUI()

Method Summary

Modifier and Type	Method and Description
MediaType[]	forMediaTypes() This UI applies to HTML requests only.
Div	swap(BeanSession beanSession, Swagger swagger) If this transform is to be used to serialize non-serializable POJOs, it must implement this method.

Methods inherited from class org.apache.juneau.transform.PojoSwap

forMediaTypes, getNormalClass, getSwapClass, getSwapClassMeta, isNormalObject, isSwappedObject, match, swap, toString, unswap, unswap, withTemplate, withTemplate

Methods inherited from class java.lang.Object

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

Field Detail

SWAGGERUI_resolveRefsMaxDepth

public static final String SWAGGERUI_resolveRefsMaxDepth

Configuration property: Resolve $ref references in schema up to the specified depth.

Property:

• ID: SWAGGERUI_resolveRefsMaxDepth
• Name: "SwaggerUI.resolveRefsMaxDepth.i"
• Data type: int
• System property: SwaggerUI.resolveRefsMaxDepth
• Environment variable: SWAGGERUI_RESOLVEREFSMAXDEPTH
• Default: 1
• Session property: true

Description:

Defines the maximum recursive depth to resolve $ref variables in schema infos.
The default 1 means only resolve the first reference encountered.
A value of 0 disables reference resolution altogether.

Example:

// Resolve schema references up to 5 levels deep. @Rest( properties={ @Property(name=SWAGGERUI_resolveRefsMaxDepth, value="5") } public class MyResource {...}

See Also:

Constant Field Values

Constructor Detail

SwaggerUI

public SwaggerUI()

Method Detail

forMediaTypes

public MediaType[] forMediaTypes()

This UI applies to HTML requests only.

Overrides:

forMediaTypes in class PojoSwap<Swagger,Div>

Returns:

The media types that this swap is applicable to, or null if it's applicable for all media types.

swap

public Div swap(BeanSession beanSession,
                Swagger swagger)
         throws Exception

Description copied from class: PojoSwap

If this transform is to be used to serialize non-serializable POJOs, it must implement this method.

The object must be converted into one of the following serializable types:

• String
• Number
• Boolean
• Collection containing anything on this list.
• Map containing anything on this list.
• A java bean with properties of anything on this list.
• An array of anything on this list.

Overrides:

swap in class PojoSwap<Swagger,Div>

Parameters:

beanSession - The bean session to use to get the class meta. This is always going to be the same bean context that created this swap.

swagger - The object to be transformed.

Returns:

The transformed object.

Throws:

Exception - If a problem occurred trying to convert the output.