Added api to contribute defaults

dilipkrish · dilipkrish · commit 0decea3bfdfd · 2020-07-12T17:18:41.000-05:00
The earlier defaults plugin API was janky and was not conducive to layering defaults and extensible. Added the apply API so that defaults can be contirbuted to via plugins

(3354)
diff --git a/springfox-spi/src/main/java/springfox/documentation/spi/service/DefaultsProviderPlugin.java b/springfox-spi/src/main/java/springfox/documentation/spi/service/DefaultsProviderPlugin.java
@@ -25,11 +25,21 @@
 
 public interface DefaultsProviderPlugin extends Plugin<DocumentationType> {
   /**
-   * Implement this method to override the @see  springfox.documentation.spi.service.contexts
-   * .DocumentationContextBuilder
+   * Use {@link DefaultsProviderPlugin#apply(DocumentationContextBuilder)} instead
    *
    * @param documentationType - creates a default DocumentationContextBuilder based on documentation type
    * @return - returns the documentation context builder
+   * @deprecated @since 3.0.0
    */
+  @Deprecated
   DocumentationContextBuilder create(DocumentationType documentationType);
+
+  /**
+   * Implement this method to override enrich the documentation context builder with documentation type specific
+   * defaults.
+   *
+   * @param builder - creates a default DocumentationContextBuilder based on documentation type
+   * @return - returns the documentation context builder
+   */
+  DocumentationContextBuilder apply(DocumentationContextBuilder builder);
 }
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/plugins/DefaultConfiguration.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/plugins/DefaultConfiguration.java
@@ -58,6 +58,20 @@ public DocumentationContextBuilder create(DocumentationType documentationType) {
         .selector(ApiSelector.DEFAULT);
   }
 
+  @Override
+  public DocumentationContextBuilder apply(DocumentationContextBuilder builder) {
+    return builder.operationOrdering(defaults.operationOrdering())
+        .apiDescriptionOrdering(defaults.apiDescriptionOrdering())
+        .apiListingReferenceOrdering(defaults.apiListingReferenceOrdering())
+        .additionalIgnorableTypes(defaults.defaultIgnorableParameterTypes())
+        .rules(defaults.defaultRules(typeResolver))
+        .defaultResponses(defaults.defaultResponses())
+        .pathProvider(pathProvider)
+        .typeResolver(typeResolver)
+        .enableUrlTemplating(false)
+        .selector(ApiSelector.DEFAULT);
+  }
+
   @Override
   public boolean supports(DocumentationType delimiter) {
     return true;
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/plugins/DocumentationPluginsManager.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/plugins/DocumentationPluginsManager.java
@@ -171,11 +171,12 @@ private DocumentationPlugin defaultDocumentationPlugin() {
     return new Docket(DocumentationType.OAS_30);
   }
 
-  public DocumentationContextBuilder createContextBuilder(
+  public DocumentationContextBuilder applyDefaults(
       DocumentationType documentationType,
-      DefaultsProviderPlugin defaultConfiguration) {
-    return defaultsProviders.getPluginOrDefaultFor(documentationType, defaultConfiguration)
-        .create(documentationType);
+      DocumentationContextBuilder builder) {
+    defaultsProviders.getPluginsFor(documentationType)
+          .forEach(each -> each.apply(builder));
+    return builder;
   }
 
   public Function<String, String> decorator(final PathContext context) {
diff --git a/springfox-spring-web/src/test/groovy/springfox/documentation/spring/web/plugins/DocumentationPluginsBootstrapperSpec.groovy b/springfox-spring-web/src/test/groovy/springfox/documentation/spring/web/plugins/DocumentationPluginsBootstrapperSpec.groovy
@@ -50,7 +50,7 @@ class DocumentationPluginsBootstrapperSpec extends Specification {
               new MockEnvironment())
 
   def setup() {
-    pluginManager.createContextBuilder(_, _) >> new DocumentationContextBuilder(DocumentationType.SWAGGER_12)
+    pluginManager.applyDefaults(_, _) >> new DocumentationContextBuilder(DocumentationType.SWAGGER_12)
     handlerProvider.requestHandlers() >> []
     apiGroup.scan(_) >> group
     group.getGroupName() >> "default"
diff --git a/springfox-swagger-common/src/test/groovy/springfox/documentation/swagger/readers/parameter/ModelAttributeParameterExpanderSpec.groovy b/springfox-swagger-common/src/test/groovy/springfox/documentation/swagger/readers/parameter/ModelAttributeParameterExpanderSpec.groovy
@@ -108,6 +108,15 @@ class ModelAttributeParameterExpanderSpec extends DocumentationContextSpec imple
           .rules(rules)
     }
 
+    @Override
+    DocumentationContextBuilder apply(DocumentationContextBuilder builder) {
+      List<AlternateTypeRule> rules = new ArrayList<>()
+      rules.add(newRule(typeResolver.resolve(Map.class, String.class, String.class),
+          typeResolver.resolve(Object.class)))
+      rules.add(newMapRule(WildcardType.class, WildcardType.class))
+      return builder.rules(rules)
+    }
+
     @Override
     boolean supports(DocumentationType delimiter) {
       return true
diff --git a/springfox-swagger1/src/main/java/springfox/documentation/swagger1/web/SwaggerDefaultConfiguration.java b/springfox-swagger1/src/main/java/springfox/documentation/swagger1/web/SwaggerDefaultConfiguration.java
@@ -59,6 +59,15 @@ public DocumentationContextBuilder create(DocumentationType documentationType) {
         .rules(rules);
   }
 
+  @Override
+  public DocumentationContextBuilder apply(DocumentationContextBuilder builder) {
+    List<AlternateTypeRule> rules = new ArrayList<>();
+    rules.add(newRule(typeResolver.resolve(Map.class, String.class, String.class),
+        typeResolver.resolve(Object.class)));
+    rules.add(newMapRule(WildcardType.class, WildcardType.class));
+    return builder.rules(rules);
+  }
+
   @Override
   public boolean supports(DocumentationType delimiter) {
     return DocumentationType.SWAGGER_12.equals(delimiter);
