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.String validatorUrl)
UiConfiguration(java.lang.String validatorUrl, java.lang.String[] supportedSubmitMethods)
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
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) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApisSorter()
java.lang.String	getDefaultModelRendering()
java.lang.String	getDocExpansion()
java.lang.Long	getRequestTimeout()
java.lang.String[]	getSupportedSubmitMethods()
java.lang.String	getValidatorUrl()
boolean	isJsonEditor()
boolean	isShowRequestHeaders()

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)

UiConfiguration

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

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 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 - An array of of the HTTP operations that will have the 'Try it out!' option. An empty array disables 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

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)

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 - An array of of the HTTP operations that will have the 'Try it out!' option. An empty array disables 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

Method Detail

getValidatorUrl

public java.lang.String getValidatorUrl()

getDocExpansion

public java.lang.String getDocExpansion()

getApisSorter

public java.lang.String getApisSorter()

getDefaultModelRendering

public java.lang.String getDefaultModelRendering()

getSupportedSubmitMethods

public java.lang.String[] getSupportedSubmitMethods()

isJsonEditor

public boolean isJsonEditor()

isShowRequestHeaders

public boolean isShowRequestHeaders()

getRequestTimeout

public java.lang.Long getRequestTimeout()