Add support for showCommonExtensions configuration options for swagge…

…r-ui
springfox · Sep 7, 2018 · 6b3e4d7 · 6b3e4d7
1 parent a04d57b
commit 6b3e4d7
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 0 deletions.
diff --git a/springfox-spring-config/src/main/java/springfox/springconfig/Swagger2SpringBoot.java b/springfox-spring-config/src/main/java/springfox/springconfig/Swagger2SpringBoot.java
@@ -158,6 +158,7 @@ UiConfiguration uiConfig() {
         .maxDisplayedTags(null)
         .operationsSorter(OperationsSorter.ALPHA)
         .showExtensions(false)
+        .showCommonExtensions(false)
         .tagsSorter(TagsSorter.ALPHA)
         .supportedSubmitMethods(UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS)
         .validatorUrl(null)

diff --git a/...fox-swagger-common/src/main/java/springfox/documentation/swagger/web/UiConfiguration.java b/...fox-swagger-common/src/main/java/springfox/documentation/swagger/web/UiConfiguration.java
@@ -46,6 +46,7 @@ public class UiConfiguration {
   private final Integer maxDisplayedTags;
   private final OperationsSorter operationsSorter;
   private final Boolean showExtensions;
+  private final Boolean showCommonExtensions;
   private final TagsSorter tagsSorter;
   private final String validatorUrl;
   /**
@@ -190,6 +191,7 @@ public UiConfiguration(
     this.maxDisplayedTags = null;
     this.operationsSorter = OperationsSorter.of(apisSorter);
     this.showExtensions = false;
+    this.showCommonExtensions = false;
     this.tagsSorter = TagsSorter.of(apisSorter);
   }
 
@@ -222,6 +224,8 @@ public UiConfiguration(
    *                                 returned by the server unchanged.
    * @param showExtensions           Controls the display of vendor extension (x-) fields and values for Operations,
    *                                 Parameters, and Schema.
+   * @param showCommonExtensions     Controls the display of extensions (pattern, maxLength, minLength, maximum,
+   *                                 minimum) fields and values for Parameters.
    * @param 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.
@@ -243,6 +247,7 @@ public UiConfiguration(
       Integer maxDisplayedTags,
       OperationsSorter operationsSorter,
       Boolean showExtensions,
+      Boolean showCommonExtensions,
       TagsSorter tagsSorter,
       String validatorUrl) {
     this(
@@ -257,6 +262,7 @@ public UiConfiguration(
         maxDisplayedTags,
         operationsSorter,
         showExtensions,
+        showCommonExtensions,
         tagsSorter,
         Constants.DEFAULT_SUBMIT_METHODS,
         validatorUrl);
@@ -291,6 +297,8 @@ public UiConfiguration(
    *                                 returned by the server unchanged.
    * @param showExtensions           Controls the display of vendor extension (x-) fields and values for Operations,
    *                                 Parameters, and Schema.
+   * @param showCommonExtensions     Controls the display of extensions (pattern, maxLength, minLength, maximum,
+   *                                 minimum) fields and values for Parameters.
    * @param 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.
@@ -316,6 +324,7 @@ public UiConfiguration(
       Integer maxDisplayedTags,
       OperationsSorter operationsSorter,
       Boolean showExtensions,
+      Boolean showCommonExtensions,
       TagsSorter tagsSorter,
       String[] supportedSubmitMethods,
       String validatorUrl) {
@@ -331,6 +340,7 @@ public UiConfiguration(
     this.maxDisplayedTags = maxDisplayedTags;
     this.operationsSorter = operationsSorter;
     this.showExtensions = showExtensions;
+    this.showCommonExtensions = showCommonExtensions;
     this.tagsSorter = tagsSorter;
     this.supportedSubmitMethods = supportedSubmitMethods;
     this.validatorUrl = validatorUrl;
@@ -431,6 +441,11 @@ public Boolean getShowExtensions() {
     return showExtensions;
   }
 
+  @JsonProperty("showCommonExtensions")
+  public Boolean getShowCommonExtensions() {
+    return showCommonExtensions;
+  }
+
   @JsonProperty("tagsSorter")
   public TagsSorter getTagsSorter() {
     return tagsSorter;

diff --git a/...gger-common/src/main/java/springfox/documentation/swagger/web/UiConfigurationBuilder.java b/...gger-common/src/main/java/springfox/documentation/swagger/web/UiConfigurationBuilder.java
@@ -36,6 +36,7 @@ public class UiConfigurationBuilder {
   private Integer maxDisplayedTags;
   private OperationsSorter operationsSorter;
   private Boolean showExtensions;
+  private Boolean showCommonExtensions;
   private TagsSorter tagsSorter;
 
   /*--------------------------------------------*\
@@ -64,6 +65,7 @@ public UiConfiguration build() {
         defaultIfAbsent(maxDisplayedTags, null),
         defaultIfAbsent(operationsSorter, OperationsSorter.ALPHA),
         defaultIfAbsent(showExtensions, false),
+        defaultIfAbsent(showCommonExtensions, false),
         defaultIfAbsent(tagsSorter, TagsSorter.ALPHA),
         defaultIfAbsent(supportedSubmitMethods, UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS),
         defaultIfAbsent(validatorUrl, null)
@@ -181,6 +183,16 @@ public UiConfigurationBuilder showExtensions(Boolean showExtensions) {
     return this;
   }
 
+  /**
+   * @param showCommonExtensions Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum)
+   *                             fields and values for Parameters.
+   * @return this
+   */
+  public UiConfigurationBuilder showCommonExtensions(Boolean showCommonExtensions) {
+    this.showCommonExtensions = showCommonExtensions;
+    return this;
+  }
+
   /**
    * @param 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

diff --git a/...mmon/src/test/groovy/springfox/documentation/swagger/web/ApiResourceControllerSpec.groovy b/...mmon/src/test/groovy/springfox/documentation/swagger/web/ApiResourceControllerSpec.groovy
@@ -60,6 +60,7 @@ class ApiResourceControllerSpec extends Specification {
     "maxDisplayedTags": 1000,
     "operationsSorter": "alpha",
     "showExtensions": false,
+    "showCommonExtensions": false,
     "tagsSorter": "alpha",
     "supportedSubmitMethods":["get","put","post","delete","options","head","patch","trace"],
     "validatorUrl": "/validate"
@@ -105,6 +106,7 @@ class ApiResourceControllerSpec extends Specification {
           .maxDisplayedTags(1000)
           .operationsSorter(OperationsSorter.ALPHA)
           .showExtensions(false)
+          .showCommonExtensions(false)
           .tagsSorter(TagsSorter.ALPHA)
           .supportedSubmitMethods(UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS)
           .validatorUrl("/validate")

diff --git a/...mon/src/test/groovy/springfox/documentation/swagger/web/UiConfigurationBuilderSpec.groovy b/...mon/src/test/groovy/springfox/documentation/swagger/web/UiConfigurationBuilderSpec.groovy
@@ -40,6 +40,7 @@ class UiConfigurationBuilderSpec extends Specification {
       "    \"filter\": false,\n" +
       "    \"operationsSorter\": \"alpha\",\n" +
       "    \"showExtensions\": false,\n" +
+      "    \"showCommonExtensions\": false,\n" +
       "    \"tagsSorter\": \"alpha\",\n" +
       "    \"supportedSubmitMethods\": [\"get\",\"put\",\"post\",\"delete\",\"options\",\"head\",\"patch\"," +
       "\"trace\"],\n" +

diff --git a/...ger-common/src/test/groovy/springfox/documentation/swagger/web/UiConfigurationSpec.groovy b/...ger-common/src/test/groovy/springfox/documentation/swagger/web/UiConfigurationSpec.groovy
@@ -40,6 +40,7 @@ class UiConfigurationSpec extends Specification {
       "    \"filter\": false,\n" +
       "    \"operationsSorter\": \"alpha\",\n" +
       "    \"showExtensions\": false,\n" +
+      "    \"showCommonExtensions\": false,\n" +
       "    \"tagsSorter\": \"alpha\",\n" +
       "    \"validatorUrl\": \"validator:urn\"\n" +
       "}"
@@ -59,6 +60,7 @@ class UiConfigurationSpec extends Specification {
       "    \"filter\": false,\n" +
       "    \"operationsSorter\": \"alpha\",\n" +
       "    \"showExtensions\": false,\n" +
+      "    \"showCommonExtensions\": false,\n" +
       "    \"tagsSorter\": \"alpha\",\n" +
       "    \"validatorUrl\": \"\"\n" +
       "}"