Package com.pixelservices.flash.swagger

Enum Class OpenAPIUITemplate

java.lang.Object

java.lang.Enum<OpenAPIUITemplate>

com.pixelservices.flash.swagger.OpenAPIUITemplate

All Implemented Interfaces:

Serializable, Comparable<OpenAPIUITemplate>, Constable

public enum OpenAPIUITemplate
extends Enum<OpenAPIUITemplate>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM
REDOC
SWAGGER_UI

Method Summary

Modifier and Type	Method	Description
String	getTemplate()	Gets the template for the UI.
static void	setCustom(String customTemplate)	Sets the custom HTML template for the UI.
static OpenAPIUITemplate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAPIUITemplate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SWAGGER_UI

public static final OpenAPIUITemplate SWAGGER_UI

REDOC

public static final OpenAPIUITemplate REDOC

CUSTOM

public static final OpenAPIUITemplate CUSTOM

Method Details

values

public static OpenAPIUITemplate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpenAPIUITemplate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTemplate

public String getTemplate()

Gets the template for the UI.

Returns:

The template for the UI.

setCustom

public static void setCustom(String customTemplate)

Sets the custom HTML template for the UI. It will be available as CUSTOM. You can reference the endpoint using the placeholder %s, the schema.json will be accessible at the endpoint as %s/schema.json.

Parameters:

customTemplate - The custom template for the UI as an HTML string.