springfox.documentation.swagger.web

Class UiConfiguration

java.lang.Object

springfox.documentation.swagger.web.UiConfiguration

public class UiConfiguration
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UiConfiguration.Constants

Constructor Summary

Constructors

Constructor and Description
UiConfiguration(java.lang.Boolean deepLinking, java.lang.Boolean displayOperationId, java.lang.Integer defaultModelsExpandDepth, java.lang.Integer defaultModelExpandDepth, ModelRendering defaultModelRendering, java.lang.Boolean displayRequestDuration, DocExpansion docExpansion, java.lang.Object filter, java.lang.Integer maxDisplayedTags, OperationsSorter operationsSorter, java.lang.Boolean showExtensions, TagsSorter tagsSorter, java.lang.String validatorUrl) Default constructor
UiConfiguration(java.lang.Boolean deepLinking, java.lang.Boolean displayOperationId, java.lang.Integer defaultModelsExpandDepth, java.lang.Integer defaultModelExpandDepth, ModelRendering defaultModelRendering, java.lang.Boolean displayRequestDuration, DocExpansion docExpansion, java.lang.Object filter, java.lang.Integer maxDisplayedTags, OperationsSorter operationsSorter, java.lang.Boolean showExtensions, TagsSorter tagsSorter, java.lang.String[] supportedSubmitMethods, java.lang.String validatorUrl) Default constructor
UiConfiguration(java.lang.String validatorUrl) Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead
UiConfiguration(java.lang.String validatorUrl, java.lang.String[] supportedSubmitMethods) Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead
UiConfiguration(java.lang.String validatorUrl, java.lang.String docExpansion, java.lang.String apisSorter, java.lang.String defaultModelRendering, java.lang.String[] supportedSubmitMethods, boolean jsonEditor, boolean showRequestHeaders) Deprecated. @since 2.6.1. Use the UiConfigurationBuilder instead
UiConfiguration(java.lang.String validatorUrl, java.lang.String docExpansion, java.lang.String apisSorter, java.lang.String defaultModelRendering, java.lang.String[] supportedSubmitMethods, boolean jsonEditor, boolean showRequestHeaders, java.lang.Long requestTimeout) Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApisSorter() Deprecated. @since 2.8.0
java.lang.Boolean	getDeepLinking()
java.lang.Integer	getDefaultModelExpandDepth()
ModelRendering	getDefaultModelRendering()
java.lang.Integer	getDefaultModelsExpandDepth()
java.lang.Boolean	getDisplayOperationId()
java.lang.Boolean	getDisplayRequestDuration()
DocExpansion	getDocExpansion()
java.lang.Object	getFilter()
java.lang.Integer	getMaxDisplayedTags()
OperationsSorter	getOperationsSorter()
java.lang.Long	getRequestTimeout() Deprecated. @since 2.8.0
java.lang.Boolean	getShowExtensions()
java.lang.String[]	getSupportedSubmitMethods()
TagsSorter	getTagsSorter()
java.lang.String	getValidatorUrl()
boolean	isJsonEditor() Deprecated. @since 2.8.0
boolean	isShowRequestHeaders() Deprecated. @since 2.8.0

Methods inherited from class java.lang.Object

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

Constructor Detail

UiConfiguration

public UiConfiguration(java.lang.String validatorUrl)

Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead

Parameters:

validatorUrl - - validator url

UiConfiguration

public UiConfiguration(java.lang.String validatorUrl,
                       java.lang.String[] supportedSubmitMethods)

Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead

Parameters:

validatorUrl - - validator url

supportedSubmitMethods - - supported http methods (get,post etc.)

UiConfiguration

@Deprecated
public UiConfiguration(java.lang.String validatorUrl,
                                   java.lang.String docExpansion,
                                   java.lang.String apisSorter,
                                   java.lang.String defaultModelRendering,
                                   java.lang.String[] supportedSubmitMethods,
                                   boolean jsonEditor,
                                   boolean showRequestHeaders)

Deprecated. @since 2.6.1. Use the UiConfigurationBuilder instead

Use the default constructor instead (with requestTimeout) UiConfiguration(String, String, String, String, String[], boolean, boolean, Long) )}

Parameters:

validatorUrl - By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation. This parameter is relevant for Swagger 2.0 specs only.

docExpansion - Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details).

apisSorter - Apply a sort to the API/tags list. It can be 'alpha' (sort by name) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

defaultModelRendering - Controls how models are shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Model Schema' links.) It can be set to 'model' or 'schema', and the default is 'schema'.

supportedSubmitMethods - List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display.

jsonEditor - Enables a graphical view for editing complex bodies. Defaults to false.

showRequestHeaders - Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to false.

UiConfiguration

@Deprecated
public UiConfiguration(java.lang.String validatorUrl,
                                   java.lang.String docExpansion,
                                   java.lang.String apisSorter,
                                   java.lang.String defaultModelRendering,
                                   java.lang.String[] supportedSubmitMethods,
                                   boolean jsonEditor,
                                   boolean showRequestHeaders,
                                   java.lang.Long requestTimeout)

Deprecated. @since 2.8.0. Use the UiConfigurationBuilder instead

Default constructor

Parameters:

validatorUrl - By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation. This parameter is relevant for Swagger 2.0 specs only.

docExpansion - Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details).

apisSorter - Apply a sort to the API/tags list. It can be 'alpha' (sort by name) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

defaultModelRendering - Controls how models are shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Model Schema' links.) It can be set to 'model' or 'schema', and the default is 'schema'.

supportedSubmitMethods - List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display.

jsonEditor - Enables a graphical view for editing complex bodies. Defaults to false.

showRequestHeaders - Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to false.

requestTimeout - - XHR timeout

UiConfiguration

public UiConfiguration(java.lang.Boolean deepLinking,
                       java.lang.Boolean displayOperationId,
                       java.lang.Integer defaultModelsExpandDepth,
                       java.lang.Integer defaultModelExpandDepth,
                       ModelRendering defaultModelRendering,
                       java.lang.Boolean displayRequestDuration,
                       DocExpansion docExpansion,
                       java.lang.Object filter,
                       java.lang.Integer maxDisplayedTags,
                       OperationsSorter operationsSorter,
                       java.lang.Boolean showExtensions,
                       TagsSorter tagsSorter,
                       java.lang.String validatorUrl)

Default constructor

Parameters:

deepLinking - If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information.

displayOperationId - Controls the display of operationId in operations list. The default is false.

defaultModelsExpandDepth - The default expansion depth for models (set to -1 completely hide the models).

defaultModelExpandDepth - The default expansion depth for the model on the model-example section.

defaultModelRendering - Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.)

displayRequestDuration - Controls the display of the request duration (in milliseconds) for Try-It-Out requests.

docExpansion - Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).

filter - If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.

maxDisplayedTags - If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations.

operationsSorter - Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

showExtensions - Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema.

tagsSorter - Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort() to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger-UI.

validatorUrl - By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation. This parameter is relevant for Swagger 2.0 specs only.

UiConfiguration

public UiConfiguration(java.lang.Boolean deepLinking,
                       java.lang.Boolean displayOperationId,
                       java.lang.Integer defaultModelsExpandDepth,
                       java.lang.Integer defaultModelExpandDepth,
                       ModelRendering defaultModelRendering,
                       java.lang.Boolean displayRequestDuration,
                       DocExpansion docExpansion,
                       java.lang.Object filter,
                       java.lang.Integer maxDisplayedTags,
                       OperationsSorter operationsSorter,
                       java.lang.Boolean showExtensions,
                       TagsSorter tagsSorter,
                       java.lang.String[] supportedSubmitMethods,
                       java.lang.String validatorUrl)

Default constructor

Parameters:

deepLinking - If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information.

displayOperationId - Controls the display of operationId in operations list. The default is false.

defaultModelsExpandDepth - The default expansion depth for models (set to -1 completely hide the models).

defaultModelExpandDepth - The default expansion depth for the model on the model-example section.

defaultModelRendering - Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.)

displayRequestDuration - Controls the display of the request duration (in milliseconds) for Try-It-Out requests.

docExpansion - Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).

filter - If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.

maxDisplayedTags - If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations.

operationsSorter - Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.

showExtensions - Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema.

tagsSorter - Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort() to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger-UI.

supportedSubmitMethods - List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display.

validatorUrl - By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation. This parameter is relevant for Swagger 2.0 specs only.

Method Detail

getApisSorter

@Deprecated
public java.lang.String getApisSorter()

Deprecated. @since 2.8.0

Returns:

apisSorter

isJsonEditor

@Deprecated
public boolean isJsonEditor()

Deprecated. @since 2.8.0

Returns:

jsonEditor

isShowRequestHeaders

@Deprecated
public boolean isShowRequestHeaders()

Deprecated. @since 2.8.0

Returns:

showRequestHeaders

getRequestTimeout

@Deprecated
public java.lang.Long getRequestTimeout()

Deprecated. @since 2.8.0

Returns:

requestTimeout

getDeepLinking

public java.lang.Boolean getDeepLinking()

getDisplayOperationId

public java.lang.Boolean getDisplayOperationId()

getDefaultModelsExpandDepth

public java.lang.Integer getDefaultModelsExpandDepth()

getDefaultModelExpandDepth

public java.lang.Integer getDefaultModelExpandDepth()

getDefaultModelRendering

public ModelRendering getDefaultModelRendering()

getDisplayRequestDuration

public java.lang.Boolean getDisplayRequestDuration()

getDocExpansion

public DocExpansion getDocExpansion()

getFilter

public java.lang.Object getFilter()

getMaxDisplayedTags

public java.lang.Integer getMaxDisplayedTags()

getOperationsSorter

public OperationsSorter getOperationsSorter()

getShowExtensions

public java.lang.Boolean getShowExtensions()

getTagsSorter

public TagsSorter getTagsSorter()

getSupportedSubmitMethods

public java.lang.String[] getSupportedSubmitMethods()

getValidatorUrl

public java.lang.String getValidatorUrl()