Simplified the configuration and updated the documentation

Author: dilipkrish

README.adoc

@@ -93,6 +93,11 @@ dependencies {
 
 NOTE: The current snapshot version that is available is `1.0.0-SNAPSHOT`
 
+== Demo application
+
+The demo application is available in https://github.com/springfox/springfox-grails-demo[this repository]. You can
+see a live demo running or https://immense-escarpment-17128.herokuapp.com/swagger-ui.html[heroku here].
+
 ===== Configure the springfox grails integration
 
 In your Application (GrailsAutoConfiguration) startup entry-point follow the steps below
@@ -113,16 +118,12 @@ class Application extends GrailsAutoConfiguration {
   // 3. **Optionally** define a custom docket or omit this step to use the default
   // For grails it is preferrable to use use the following settings.
   @Bean
-  Docket api(List<AlternateTypeRuleConvention> conventions) { //<1>
-    def typeRules = conventions.collectMany {
-      it.rules()
-    }
+  Docket api() {
     new Docket(DocumentationType.SWAGGER_2)
         .ignoredParameterTypes(MetaClass)
         .select()
         .paths(not(ant("/error")))
         .build()
-        .alternateTypeRules(typeRules.toArray(new AlternateTypeRule[typeRules.size()]))
   }
 
    // 4. **Optionally** in the absense of asset pipeline configure the swagger-ui webjar to serve the scaffolded
@@ -147,7 +148,6 @@ class Application extends GrailsAutoConfiguration {
     }
 }
 ----
-<1> Conventions are way to describe conventions specific to grails
 
 ==== Swagger UI integration
 
@@ -186,6 +186,16 @@ dependencies {
 
 NOTE: The current snapshot in development is `2.7.0-SNAPSHOT`
 
+==== Extensibility
+
+TODO: Add more docs
+- Conventions - for adding custom conventions for replacing grails types
+- GrailsPropertySelector - for overriding the selection of grails properties by the default convention
+- GrailsPropertyTransformer - for overriding the transformer of the grails property
+- GeneratedClassNamingStrategy - for naming the generated class mixins
+
+==== Trouble shooting
+
 If you get an exception when you try to run your app, this might be because of the chosen profile for your application. If you use the `rest-api` profile, everything should be fine, but if you've chosen the `web` profile, it is likely that you have to add something like
 
     grails.serverURL: http://localhost:8080

springfox-grails-contract-tests/grails-app/init/grails/springfox/sample/Application.groovy

@@ -2,20 +2,11 @@ package grails.springfox.sample
 
 import grails.boot.GrailsApp
 import grails.boot.config.GrailsAutoConfiguration
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Import
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
-import springfox.documentation.grails.DefaultGrailsPropertySelector
-import springfox.documentation.grails.DefaultGrailsPropertyTransformer
-import springfox.documentation.grails.DefaultGeneratedClassNamingStrategy
-import springfox.documentation.grails.GrailsPropertySelector
-import springfox.documentation.grails.GrailsPropertyTransformer
-import springfox.documentation.grails.GeneratedClassNamingStrategy
 import springfox.documentation.grails.SpringfoxGrailsIntegrationConfiguration
-import springfox.documentation.schema.AlternateTypeRule
-import springfox.documentation.schema.AlternateTypeRuleConvention
 import springfox.documentation.spi.DocumentationType
 import springfox.documentation.spring.web.plugins.Docket
 import springfox.documentation.swagger2.annotations.EnableSwagger2
@@ -31,34 +22,12 @@ class Application extends GrailsAutoConfiguration {
   }
 
   @Bean
-  @ConditionalOnMissingBean(GrailsPropertySelector)
-  GrailsPropertySelector propertySelector() {
-    new DefaultGrailsPropertySelector()
-  }
-
-  @Bean
-  @ConditionalOnMissingBean(GrailsPropertyTransformer)
-  GrailsPropertyTransformer propertyTransformer() {
-    new DefaultGrailsPropertyTransformer()
-  }
-
-  @Bean
-  @ConditionalOnMissingBean(GeneratedClassNamingStrategy)
-  GeneratedClassNamingStrategy namingStrategy() {
-    new DefaultGeneratedClassNamingStrategy()
-  }
-
-  @Bean
-  Docket api(List<AlternateTypeRuleConvention> conventions) {
-    def typeRules = conventions.collectMany {
-      it.rules()
-    }
+  Docket api() {
     new Docket(DocumentationType.SWAGGER_2)
         .ignoredParameterTypes(MetaClass)
         .select()
         .paths(not(ant("/error")))
         .build()
-        .alternateTypeRules(typeRules.toArray(new AlternateTypeRule[typeRules.size()]))
   }
 
   @Bean

springfox-grails/build.gradle

@@ -57,6 +57,7 @@ dependencies {
     provided "org.springframework:spring-web:$spring"
     provided "org.springframework:spring-webmvc:$spring"
     provided "org.springframework:spring-context:$spring"
+    provided "org.springframework.boot:spring-boot-autoconfigure:$springBoot"
     provided "org.grails:grails-core:$grails"
     provided "org.grails:grails-web-url-mappings:$grails"
     provided "org.grails:grails-web-url-mappings:$grails"

springfox-grails/src/main/java/springfox/documentation/grails/SpringfoxGrailsIntegrationConfiguration.java

@@ -1,9 +1,29 @@
 package springfox.documentation.grails;
 
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 @ComponentScan(basePackages = "springfox.documentation.grails")
 public class SpringfoxGrailsIntegrationConfiguration {
+
+  @Bean
+  @ConditionalOnMissingBean(GrailsPropertySelector.class)
+  public GrailsPropertySelector propertySelector() {
+    return new DefaultGrailsPropertySelector();
+  }
+
+  @Bean
+  @ConditionalOnMissingBean(GrailsPropertyTransformer.class)
+  public GrailsPropertyTransformer propertyTransformer() {
+    return new DefaultGrailsPropertyTransformer();
+  }
+
+  @Bean
+  @ConditionalOnMissingBean(GeneratedClassNamingStrategy.class)
+  GeneratedClassNamingStrategy namingStrategy() {
+    return new DefaultGeneratedClassNamingStrategy();
+  }
 }