PR to support Model enhancements

.java-version

@@ -1 +1 @@
-1.7
+1.8

gradle/dependencies.gradle

@@ -1,27 +1,28 @@
 ext {
-  byteBuddyVersion = "1.7.1"
+  byteBuddyVersion = "1.7.5"
   cglib = "3.2.5"
   classmate = "1.3.3"
   groovy = "2.4.8"
   guava = "20.0"
   jackson = '2.8.7'
   joda = "2.9.9"
-  jsonPath = "2.3.0"
+  jsonPath = "2.4.0"
   jsonAssert = "1.5.0"
   mapstruct = "1.1.0.Final"
   mockito = "1.10.19"
-  objenesis = "2.5.1"
+  oasCore = "2.0.0-rc1"
+  objenesis = "2.6"
   reflections = "0.9.11"
   servlet = "3.1.0"
   slf4j = "1.7.24"
   snakeyaml = '1.18'
   spock = "1.1-groovy-2.4"
-  spring = "4.3.9.RELEASE"
+  spring = "4.3.10.RELEASE"
   springHateoas = "0.23.0.RELEASE"
-  springDataRest = "2.6.3.RELEASE"
+  springDataRest = "2.6.6.RELEASE"
   springPluginVersion = "1.2.0.RELEASE"
-  swagger2Core = "1.5.14"
-  springBoot = "1.4.4.RELEASE"
+  swagger2Core = "1.5.16"
+  springBoot = "1.5.6.RELEASE"
   springfoxRfc6570Version = "1.0.0"
   undercouch = "3.2.0"
   validationApiVersion = '1.1.0.Final'
@@ -45,6 +46,10 @@ ext {
                   "io.swagger:swagger-annotations:${swagger2Core}",
                   "io.swagger:swagger-models:${swagger2Core}"
           ],
+          oasCore  : [
+              "io.swagger:swagger-annotations:${oasCore}",
+              "io.swagger:swagger-models:${oasCore}"
+          ],
           spring        : [
                   "org.springframework.plugin:spring-plugin-core:${springPluginVersion}",
                   "org.springframework.plugin:spring-plugin-metadata:${springPluginVersion}",

settings.gradle

@@ -6,6 +6,7 @@ include 'springfox-spring-web'
 include 'springfox-swagger-common'
 include 'springfox-swagger1'
 include 'springfox-swagger2'
+include 'springfox-oas'
 include 'springfox-bean-validators'
 include 'springfox-data-rest'
 include 'springfox-swagger-ui'

springfox-core/src/main/java/springfox/documentation/builders/DocumentationBuilder.java

@@ -24,7 +24,9 @@
 import com.google.common.collect.TreeMultimap;
 import springfox.documentation.service.ApiListing;
 import springfox.documentation.service.Documentation;
+import springfox.documentation.service.DocumentationReference;
 import springfox.documentation.service.ResourceListing;
+import springfox.documentation.service.Server;
 import springfox.documentation.service.Tag;
 import springfox.documentation.service.VendorExtension;
 
@@ -46,6 +48,8 @@ public class DocumentationBuilder {
   private Set<String> consumes = newLinkedHashSet();
   private String host;
   private Set<String> schemes = newLinkedHashSet();
+  private List<Server> servers = new ArrayList<Server>();
+  private DocumentationReference documentationReference;
   private List<VendorExtension> vendorExtensions = new ArrayList<VendorExtension>();
 
 
@@ -159,6 +163,27 @@ public DocumentationBuilder extensions(List<VendorExtension> extensions) {
     return this;
   }
 
+  /**
+   * Adds servers information for this API
+   *
+   * @param servers - servers
+   * @return this
+   */
+  public DocumentationBuilder servers(List<Server> servers) {
+    this.servers.addAll(nullToEmptyList(servers));
+    return this;
+  }
+
+  /**
+   * Adds external documentation information for this API
+   *
+   * @param documentationReference - external documentation reference
+   * @return this
+   */
+  public DocumentationBuilder documentationReference(DocumentationReference documentationReference) {
+    this.documentationReference = defaultIfAbsent(documentationReference, this.documentationReference);
+    return this;
+  }
 
   public static Comparator<ApiListing> byListingPosition() {
     return new Comparator<ApiListing>() {
@@ -180,6 +205,8 @@ public Documentation build() {
         consumes,
         host,
         schemes,
+        servers,
+        documentationReference,
         vendorExtensions);
   }
 }

springfox-core/src/main/java/springfox/documentation/service/ApiListing.java

@@ -36,6 +36,14 @@ public class ApiListing {
   private final List<SecurityReference> securityReferences;
   private final List<ApiDescription> apis;
   private final Map<String, Model> models;
+//  private Map<String, ApiResponse> responses = null;
+//  private Map<String, Parameter> parameters = null;
+//  private Map<String, Example> examples = null;
+//  private Map<String, RequestBody> requestBodies = null;
+//  private Map<String, Header> headers = null;
+//  private Map<String, SecurityScheme> securitySchemes = null;
+//  private Map<String, Link> links = null;
+//  private Map<String, Callback> callbacks = null;
   private final String description;
   private final int position;
   private final Set<Tag> tags;

springfox-core/src/main/java/springfox/documentation/service/Documentation.java

@@ -37,6 +37,8 @@ public class Documentation {
   private final Set<String> consumes;
   private final String host;
   private final Set<String> schemes;
+  private final List<Server> servers;
+  private final DocumentationReference documentationReference;
   private final List<VendorExtension> vendorExtensions;
 
   public Documentation(
@@ -49,6 +51,8 @@ public Documentation(
       Set<String> consumes,
       String host,
       Set<String> schemes,
+      List<Server> servers,
+      DocumentationReference documentationReference,
       Collection<VendorExtension> vendorExtensions) {
 
     this.groupName = groupName;
@@ -60,6 +64,8 @@ public Documentation(
     this.consumes = consumes;
     this.host = host;
     this.schemes = schemes;
+    this.servers = servers;
+    this.documentationReference = documentationReference;
     this.vendorExtensions = newArrayList(vendorExtensions);
   }
 
@@ -102,4 +108,12 @@ public List<String> getConsumes() {
   public List<VendorExtension> getVendorExtensions() {
     return vendorExtensions;
   }
+
+  public List<Server> getServers() {
+    return servers;
+  }
+
+  public DocumentationReference getDocumentationReference() {
+    return documentationReference;
+  }
 }

springfox-core/src/main/java/springfox/documentation/service/DocumentationReference.java

@@ -0,0 +1,49 @@
+/*
+ *
+ *  Copyright 2017-2018 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.service;
+
+import java.util.List;
+
+public class DocumentationReference {
+  private String description = null;
+  private String url = null;
+  private List<VendorExtension> extensions = null;
+
+  public DocumentationReference(
+      String description,
+      String url,
+      List<VendorExtension> extensions) {
+
+    this.description = description;
+    this.url = url;
+    this.extensions = extensions;
+  }
+
+  public String getDescription() {
+    return description;
+  }
+
+  public String getUrl() {
+    return url;
+  }
+
+  public List<VendorExtension> getExtensions() {
+    return extensions;
+  }
+}

springfox-core/src/main/java/springfox/documentation/service/Server.java

@@ -0,0 +1,56 @@
+/*
+ *
+ *  Copyright 2017-2018 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.service;
+
+import java.util.List;
+import java.util.Map;
+
+public class Server {
+  private String url = null;
+  private String description = null;
+  private Map<String, ServerVariable> variables = null;
+  private List<VendorExtension> extensions = null;
+
+  public Server(
+      String url,
+      String description,
+      Map<String, ServerVariable> variables,
+      List<VendorExtension> extensions) {
+    this.url = url;
+    this.description = description;
+    this.variables = variables;
+    this.extensions = extensions;
+  }
+
+  public String getUrl() {
+    return url;
+  }
+
+  public String getDescription() {
+    return description;
+  }
+
+  public Map<String, ServerVariable> getVariables() {
+    return variables;
+  }
+
+  public List<VendorExtension> getExtensions() {
+    return extensions;
+  }
+}

springfox-core/src/main/java/springfox/documentation/service/ServerVariable.java

@@ -0,0 +1,57 @@
+/*
+ *
+ *  Copyright 2017-2018 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.service;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ServerVariable {
+  private List<String> allowedValues = new ArrayList<String>();
+  private String defaultValue = null;
+  private String description = null;
+  private List<VendorExtension> extensions = null;
+
+  public ServerVariable(
+      List<String> allowedValues,
+      String defaultValue,
+      String description,
+      List<VendorExtension> extensions) {
+    this.allowedValues = allowedValues;
+    this.defaultValue = defaultValue;
+    this.description = description;
+    this.extensions = extensions;
+  }
+
+  public List<String> getAllowedValues() {
+    return allowedValues;
+  }
+
+  public String getDefaultValue() {
+    return defaultValue;
+  }
+
+  public String getDescription() {
+    return description;
+  }
+
+  public List<VendorExtension> getExtensions() {
+    return extensions;
+  }
+}
+

springfox-oas/build.gradle

@@ -0,0 +1,37 @@
+plugins {
+  id "net.ltgt.apt" version "0.9"
+}
+
+ext {
+  limits = [
+      'instruction': 96,
+      'branch'     : 84,
+      'line'       : 96.5,
+      'complexity' : 87,
+      'method'     : 95,
+      'class'      : 100
+  ]
+}
+
+dependencies {
+  compile libs.oasCore
+  compile project(':springfox-spi')
+  compile project(':springfox-schema')
+  compile project(':springfox-spring-web')
+  compile libs.core
+  compile libs.spring
+
+  compile "org.mapstruct:mapstruct:$mapstruct"
+  apt "org.mapstruct:mapstruct-processor:$mapstruct"
+
+  provided libs.springProvided
+  provided libs.clientProvided
+
+  testCompile project(':springfox-core')
+  testCompile project(':springfox-core').sourceSets.test.output
+  testCompile project(':springfox-schema').sourceSets.test.output
+  testCompile project(':springfox-spring-web').sourceSets.test.output
+
+  testCompile libs.test
+  testCompile "org.skyscreamer:jsonassert:${jsonAssert}"
+}