程序包 springfox.documentation.swagger.web

类 UiConfiguration

java.lang.Object
springfox.documentation.swagger.web.UiConfiguration
public class UiConfiguration extends Object

  • 构造器详细资料

    • UiConfiguration

      public UiConfiguration(String validatorUrl)
      已过时。
      参数:
      validatorUrl - - validator url
      从以下版本开始:
      2.8.0. Use the UiConfigurationBuilder instead

    • UiConfiguration

      public UiConfiguration(String validatorUrl, String[] supportedSubmitMethods)
      已过时。
      参数:
      validatorUrl - - validator url
      supportedSubmitMethods - - supported http methods (get,post etc.)
      从以下版本开始:
      2.8.0. Use the UiConfigurationBuilder instead

    • UiConfiguration

      @Deprecated public UiConfiguration(String validatorUrl, String docExpansion, String apisSorter, String defaultModelRendering, String[] supportedSubmitMethods, boolean jsonEditor, boolean showRequestHeaders)
      已过时。
      Use the default constructor instead (with requestTimeout) UiConfiguration(String, String, String, String, String[], boolean, boolean, Long) )}
      参数:
      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.
      从以下版本开始:
      2.6.1. Use the UiConfigurationBuilder instead

    • UiConfiguration

      @Deprecated public UiConfiguration(String validatorUrl, String docExpansion, String apisSorter, String defaultModelRendering, String[] supportedSubmitMethods, boolean jsonEditor, boolean showRequestHeaders, Long requestTimeout)
      已过时。
      Default constructor
      参数:
      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
      从以下版本开始:
      2.8.0. Use the UiConfigurationBuilder instead

    • UiConfiguration

      public UiConfiguration(Boolean deepLinking, Boolean displayOperationId, Integer defaultModelsExpandDepth, Integer defaultModelExpandDepth, ModelRendering defaultModelRendering, Boolean displayRequestDuration, DocExpansion docExpansion, Object filter, Integer maxDisplayedTags, OperationsSorter operationsSorter, Boolean showExtensions, TagsSorter tagsSorter, String validatorUrl)
      Default constructor
      参数:
      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(Boolean deepLinking, Boolean displayOperationId, Integer defaultModelsExpandDepth, Integer defaultModelExpandDepth, ModelRendering defaultModelRendering, Boolean displayRequestDuration, DocExpansion docExpansion, Object filter, Integer maxDisplayedTags, OperationsSorter operationsSorter, Boolean showExtensions, TagsSorter tagsSorter, String[] supportedSubmitMethods, String validatorUrl)
      Default constructor
      参数:
      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.

  • 方法详细资料

    • getApisSorter

      @Deprecated public String getApisSorter()
      已过时。
      返回:
      apisSorter
      从以下版本开始:
      2.8.0

    • isJsonEditor

      @Deprecated public boolean isJsonEditor()
      已过时。
      返回:
      jsonEditor
      从以下版本开始:
      2.8.0

    • isShowRequestHeaders

      @Deprecated public boolean isShowRequestHeaders()
      已过时。
      返回:
      showRequestHeaders
      从以下版本开始:
      2.8.0

    • getRequestTimeout

      @Deprecated public Long getRequestTimeout()
      已过时。
      返回:
      requestTimeout
      从以下版本开始:
      2.8.0

    • getDeepLinking

      public Boolean getDeepLinking()

    • getDisplayOperationId

      public Boolean getDisplayOperationId()

    • getDefaultModelsExpandDepth

      public Integer getDefaultModelsExpandDepth()

    • getDefaultModelExpandDepth

      public Integer getDefaultModelExpandDepth()

    • getDefaultModelRendering

      public ModelRendering getDefaultModelRendering()

    • getDisplayRequestDuration

      public Boolean getDisplayRequestDuration()

    • getDocExpansion

      public DocExpansion getDocExpansion()

    • getFilter

      public Object getFilter()

    • getMaxDisplayedTags

      public Integer getMaxDisplayedTags()

    • getOperationsSorter

      public OperationsSorter getOperationsSorter()

    • getShowExtensions

      public Boolean getShowExtensions()

    • getTagsSorter

      public TagsSorter getTagsSorter()

    • getSupportedSubmitMethods

      public String[] getSupportedSubmitMethods()

    • getValidatorUrl

      public String getValidatorUrl()