Feature/webflux

buildSrc/src/main/groovy/springfox/gradlebuild/utils/ProjectDefinitions.groovy

@@ -27,10 +27,10 @@ import org.gradle.api.Project
 class ProjectDefinitions {
   static publishables(Project project) {
     return project.subprojects.findAll {
-      !['swagger-contract-tests', 'buildSrc', 'springfox-spring-config'].contains(it.name)
+      !['swagger-contract-tests', 'swagger-contract-tests-webflux', 'buildSrc', 'springfox-spring-config'].contains(it.name)
     }
   }
   static publishable(Project project) {
-    !['swagger-contract-tests', 'buildSrc', 'springfox-spring-config'].contains(project.name)
+    !['swagger-contract-tests', 'swagger-contract-tests-webflux', 'buildSrc', 'springfox-spring-config'].contains(project.name)
   }
 }

gradle/dependencies.gradle

@@ -44,6 +44,19 @@ ext {
                   "org.springframework.hateoas:spring-hateoas:${springHateoas}",
                   "nl.jqno.equalsverifier:equalsverifier:${equalsverifierVersion}"
           ],
+          testNoHateoas : [
+                  "org.springframework:spring-test:${spring}",
+                  "cglib:cglib-nodep:$cglib",
+                  "org.objenesis:objenesis:$objenesis",
+                  "org.mockito:mockito-core:${mockito}",
+                  "com.jayway.jsonpath:json-path:${jsonPath}",
+                  "org.slf4j:slf4j-simple:${slf4j}",
+                  "org.yaml:snakeyaml:${snakeyaml}",
+                  "org.spockframework:spock-spring:${spock}",
+                  "org.spockframework:spock-core:${spock}",
+                  "org.codehaus.groovy:groovy-all:${groovy}",
+                  "nl.jqno.equalsverifier:equalsverifier:${equalsverifierVersion}"
+          ],
           swagger2Core  : [
                   "io.swagger:swagger-annotations:${swagger2Core}",
                   "io.swagger:swagger-models:${swagger2Core}"
@@ -53,20 +66,36 @@ ext {
                   "org.springframework.plugin:spring-plugin-metadata:${springPluginVersion}",
           ],
           springProvided: [
+                  "org.springframework:spring-core:$spring",
+                  "org.springframework:spring-web:$spring",
+                  "org.springframework:spring-context:$spring",
+          ],
+          springProvidedWithMvc: [
                   "org.springframework:spring-core:$spring",
                   "org.springframework:spring-web:$spring",
                   "org.springframework:spring-webmvc:$spring",
                   "org.springframework:spring-context:$spring",
           ],
+          springProvidedWithFlux: [
+                  "org.springframework:spring-core:$spring",
+                  "org.springframework:spring-web:$spring",
+                  "org.springframework:spring-webflux:$spring",
+                  "org.springframework:spring-context:$spring",
+          ],
           springBootProvided: [
               "org.springframework.boot:spring-boot-autoconfigure:$springBoot"
           ],
           clientProvided: [
-                  "javax.servlet:javax.servlet-api:$servlet",
                   "com.fasterxml.jackson.core:jackson-core:${jackson}",
                   "com.fasterxml.jackson.core:jackson-databind:${jackson}",
                   "joda-time:joda-time:$joda"
           ],
+          clientProvidedServlet: [
+                  "com.fasterxml.jackson.core:jackson-core:${jackson}",
+                  "com.fasterxml.jackson.core:jackson-databind:${jackson}",
+                  "joda-time:joda-time:$joda",
+                  "javax.servlet:javax.servlet-api:$servlet",
+          ],
           core          : [
                   "com.fasterxml:classmate:${classmate}",
                   "org.slf4j:slf4j-api:${slf4j}",

settings.gradle

@@ -3,14 +3,18 @@ include 'springfox-core'
 include 'springfox-spi'
 include 'springfox-schema'
 include 'springfox-spring-web'
+include 'springfox-spring-webmvc'
+include 'springfox-spring-webflux'
 include 'springfox-swagger-common'
 include 'springfox-swagger1'
 include 'springfox-swagger2'
 include 'springfox-bean-validators'
 include 'springfox-data-rest'
 include 'springfox-swagger-ui'
 include 'springfox-petstore'
+include 'springfox-petstore-webflux'
 
 // Auxiliary projects that are not published
 include 'springfox-spring-config'
 include 'swagger-contract-tests'
+include 'swagger-contract-tests-webflux'

springfox-core/build.gradle

@@ -18,4 +18,5 @@ dependencies {
   provided libs.clientProvided
 
   testCompile libs.test
+  testCompile libs.clientProvidedServlet
 }

springfox-core/src/main/java/springfox/documentation/RequestHandler.java

@@ -23,12 +23,14 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
-import org.springframework.web.servlet.mvc.condition.NameValueExpression;
-import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
-import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
+
 import springfox.documentation.annotations.Incubating;
 import springfox.documentation.service.ResolvedMethodParameter;
 
+import springfox.documentation.spring.wrapper.NameValueExpression;
+import springfox.documentation.spring.wrapper.PatternsRequestCondition;
+import springfox.documentation.spring.wrapper.RequestMappingInfo;
+
 import java.lang.annotation.Annotation;
 import java.util.Comparator;
 import java.util.List;

springfox-core/src/main/java/springfox/documentation/spring/wrapper/NameValueExpression.java

@@ -0,0 +1,30 @@
+/*
+ *
+ *  Copyright 2015 the original author or authors.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *
+ */
+
+package springfox.documentation.spring.wrapper;
+
+public interface NameValueExpression<T> {
+
+  String getName();
+
+  T getValue();
+
+  boolean isNegated();
+
+}

springfox-core/src/main/java/springfox/documentation/spring/wrapper/PatternsRequestCondition.java

@@ -0,0 +1,28 @@
+/*
+ *
+ *  Copyright 2015 the original author or authors.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *
+ */
+
+package springfox.documentation.spring.wrapper;
+
+import java.util.Set;
+
+public interface PatternsRequestCondition<T> {
+  PatternsRequestCondition combine(PatternsRequestCondition<T> other);
+
+  Set<String> getPatterns();
+}

springfox-core/src/main/java/springfox/documentation/spring/wrapper/RequestMappingInfo.java

@@ -0,0 +1,24 @@
+/*
+ *
+ *  Copyright 2015 the original author or authors.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *
+ */
+
+package springfox.documentation.spring.wrapper;
+
+public interface RequestMappingInfo<T> {
+    T getOriginalInfo();
+}

springfox-core/src/test/groovy/springfox/documentation/builders/MockRequestHandler.java

@@ -23,12 +23,13 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
-import org.springframework.web.servlet.mvc.condition.NameValueExpression;
-import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
 import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
 import springfox.documentation.RequestHandler;
 import springfox.documentation.RequestHandlerKey;
 import springfox.documentation.service.ResolvedMethodParameter;
+import springfox.documentation.spring.wrapper.PatternsRequestConditionWrapper;
+import springfox.documentation.spring.wrapper.NameValueExpression;
+import springfox.documentation.spring.wrapper.PatternsRequestCondition;
 
 import java.lang.annotation.Annotation;
 import java.util.List;
@@ -67,7 +68,7 @@ public boolean isAnnotatedWith(Class<? extends Annotation> annotation) {
 
   @Override
   public PatternsRequestCondition getPatternsCondition() {
-    return requestMapping.getPatternsCondition();
+    return new PatternsRequestConditionWrapper(requestMapping.getPatternsCondition());
   }
 
   @Override
@@ -131,7 +132,7 @@ public <T extends Annotation> Optional<T> findControllerAnnotation(Class<T> anno
   }
 
   @Override
-  public RequestMappingInfo getRequestMapping() {
+  public springfox.documentation.spring.wrapper.RequestMappingInfo getRequestMapping() {
     return null;
   }
 }

springfox-core/src/test/groovy/springfox/documentation/spring/wrapper/PatternsRequestConditionWrapper.java

@@ -0,0 +1,45 @@
+/*
+ *
+ *  Copyright 2015-2016 the original author or authors.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *
+ */
+
+package springfox.documentation.spring.wrapper;
+
+import java.util.Set;
+
+public class PatternsRequestConditionWrapper
+        implements PatternsRequestCondition<org.springframework.web.servlet.mvc.condition.PatternsRequestCondition> {
+
+    private org.springframework.web.servlet.mvc.condition.PatternsRequestCondition condition;
+
+    public PatternsRequestConditionWrapper(org.springframework.web.servlet.mvc.condition.PatternsRequestCondition condition) {
+        this.condition = condition;
+    }
+
+    @Override
+    public PatternsRequestCondition combine(PatternsRequestCondition<org.springframework.web.servlet.mvc.condition.PatternsRequestCondition> other) {
+        if (other instanceof PatternsRequestConditionWrapper) {
+            return new PatternsRequestConditionWrapper(this.condition.combine(((PatternsRequestConditionWrapper) other).condition));
+        }
+        return this;
+    }
+
+    @Override
+    public Set<String> getPatterns() {
+        return this.condition.getPatterns();
+    }
+}

springfox-data-rest/build.gradle

@@ -15,12 +15,12 @@ dependencies {
   compile libs.core
   compile libs.spring
   compile project(':springfox-spi')
-  compile project(':springfox-spring-web')
+  compile project(':springfox-spring-webmvc')
 
   compile "org.springframework.data:spring-data-rest-webmvc:$springDataRest"
   compile "org.springframework.hateoas:spring-hateoas:${springHateoas}"
 
-  provided libs.springProvided
+  provided libs.springProvidedWithMvc
 
   testCompile project(':springfox-core')
   testCompile libs.test

springfox-data-rest/src/main/java/springfox/documentation/spring/data/rest/SpringDataRestRequestHandler.java

@@ -23,13 +23,14 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
-import org.springframework.web.servlet.mvc.condition.NameValueExpression;
-import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
-import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
 import springfox.documentation.RequestHandler;
 import springfox.documentation.RequestHandlerKey;
 import springfox.documentation.service.ResolvedMethodParameter;
+import springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper;
 import springfox.documentation.spring.web.plugins.CombinedRequestHandler;
+import springfox.documentation.spring.wrapper.NameValueExpression;
+import springfox.documentation.spring.wrapper.PatternsRequestCondition;
+import springfox.documentation.spring.wrapper.RequestMappingInfo;
 
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
@@ -65,7 +66,9 @@ public boolean isAnnotatedWith(Class<? extends Annotation> annotation) {
 
   @Override
   public PatternsRequestCondition getPatternsCondition() {
-    return new PatternsRequestCondition(actionSpecification.getPath());
+    return new WebMvcPatternsRequestConditionWrapper(
+            new org.springframework.web.servlet.mvc.condition.PatternsRequestCondition(actionSpecification.getPath())
+    );
   }
 
   @Override

springfox-petstore-webflux/build.gradle

@@ -0,0 +1,23 @@
+ext {
+  jdkVersion = 1.8
+}
+compileJava.options.encoding = 'UTF-8'
+
+buildscript {
+  repositories {
+    jcenter()
+  }
+}
+repositories {
+  jcenter()
+}
+
+dependencies {
+  compile libs.spring
+  compile libs.springProvided
+  compile libs.swagger2Core
+  compile libs.core
+  compile project(':springfox-spi')
+  compile project(':springfox-core')
+  compile project(':springfox-spring-webflux')
+}