Added java.sql.Date as a native primitive type

dilipkrish · dilipkrish · commit e99f059182ee · 2016-06-01T20:22:41.000-05:00
fixes springfox#1162
diff --git a/springfox-schema/src/main/java/springfox/documentation/schema/Types.java b/springfox-schema/src/main/java/springfox/documentation/schema/Types.java
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright 2015 the original author or authors.
+ *  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.
@@ -62,6 +62,7 @@ private Types() {
       .put(Character.TYPE, "string")
 
       .put(Date.class, "date-time")
+      .put(java.sql.Date.class, "date-time")
       .put(String.class, "string")
       .put(Object.class, "object")
       .put(Long.class, "long")
diff --git a/springfox-schema/src/test/groovy/springfox/documentation/schema/SimpleTypeSpec.groovy b/springfox-schema/src/test/groovy/springfox/documentation/schema/SimpleTypeSpec.groovy
@@ -88,6 +88,8 @@ class SimpleTypeSpec extends SchemaSpecification {
       "anObjectDouble"  | Double  | "java.lang.Double"
       "currency"        | Currency| "java.util.Currency"
       "uuid"            | UUID    | "java.util.UUID"
+      "aDate"           | Date    | "java.util.Date"
+      "aSqlDate"        | java.sql.Date   | "java.sql.Date"
   }
 
   @Ignore
diff --git a/springfox-schema/src/test/java/springfox/documentation/schema/SimpleType.java b/springfox-schema/src/test/java/springfox/documentation/schema/SimpleType.java
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright 2015 the original author or authors.
+ *  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.
@@ -43,6 +43,24 @@ public class SimpleType {
   Double anObjectDouble;
   Currency currency;
   UUID uuid;
+  Date aDate;
+  java.sql.Date aSqlDate;
+
+  public Date getaDate() {
+    return aDate;
+  }
+
+  public void setaDate(Date aDate) {
+    this.aDate = aDate;
+  }
+
+  public java.sql.Date getaSqlDate() {
+    return aSqlDate;
+  }
+
+  public void setaSqlDate(java.sql.Date aSqlDate) {
+    this.aSqlDate = aSqlDate;
+  }
 
   public Byte getAnObjectByte() {
     return anObjectByte;
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/readers/parameter/ModelAttributeParameterExpander.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/readers/parameter/ModelAttributeParameterExpander.java
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright 2015 the original author or authors.
+ *  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.
@@ -69,8 +69,11 @@ public ModelAttributeParameterExpander(TypeResolver resolver) {
     this.resolver = resolver;
   }
 
-  public void expand(final String parentName, final Class<?> paramType,
-                     final List<Parameter> parameters, DocumentationContext documentationContext) {
+  public void expand(
+      final String parentName,
+      final Class<?> paramType,
+      final List<Parameter> parameters,
+      DocumentationContext documentationContext) {
 
     Set<String> beanPropNames = getBeanPropertyNames(paramType);
     Iterable<Field> fields = from(getInstanceFields(paramType))
@@ -93,8 +96,12 @@ public void expand(final String parentName, final Class<?> paramType,
       String dataTypeName = Optional.fromNullable(typeNameFor(each.getFieldType()))
               .or(each.getFieldType().getSimpleName());
       LOG.debug("Building parameter for field: {}, with type: ", each, each.getFieldType());
-      ParameterExpansionContext parameterExpansionContext = new ParameterExpansionContext(dataTypeName, parentName,
-              each.getField(), documentationContext.getDocumentationType(), new ParameterBuilder());
+      ParameterExpansionContext parameterExpansionContext = new ParameterExpansionContext(
+          dataTypeName,
+          parentName,
+          each.getField(),
+          documentationContext.getDocumentationType(),
+          new ParameterBuilder());
       parameters.add(pluginsManager.expandParameter(parameterExpansionContext));
     }
   }
diff --git a/springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/controllers/BugsController.java b/springfox-spring-web/src/test/java/springfox/documentation/spring/web/dummy/controllers/BugsController.java
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright 2015 the original author or authors.
+ *  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.
@@ -26,6 +26,7 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
+import java.sql.Date;
 import java.util.Map;
 
 @RestController
@@ -43,4 +44,9 @@ public ResponseEntity<Void> bug1306(@RequestParam Map<String, String> paramMap)
   public ResponseEntity<String> bug1209() {
     return ResponseEntity.ok("");
   }
+
+  @RequestMapping(value = "1162", method = RequestMethod.POST)
+  public ResponseEntity<Date> bug1162() {
+    return ResponseEntity.ok(new Date(new java.util.Date().getTime()));
+  }
 }
diff --git a/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-service.json b/swagger-contract-tests/src/test/resources/contract/swagger2/declaration-bugs-service.json
@@ -26,6 +26,31 @@
     "application/json"
   ],
   "paths": {
+    "/bugs/1162": {
+      "post": {
+        "tags": [
+          "bugs-controller"
+        ],
+        "summary": "bug1162",
+        "operationId": "bug1162UsingPOST_1",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/xml",
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        }
+      }
+    },
     "/bugs/1209": {
       "post": {
         "tags": [

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/*`
`2`	`2`	`*`
`3`		`- * Copyright 2015 the original author or authors.`
	`3`	`+ * Copyright 2015-2016 the original author or authors.`
`4`	`4`	`*`
`5`	`5`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`* you may not use this file except in compliance with the License.`
`@@ -62,6 +62,7 @@ private Types() {`
`62`	`62`	`.put(Character.TYPE, "string")`
`63`	`63`
`64`	`64`	`.put(Date.class, "date-time")`
	`65`	`+ .put(java.sql.Date.class, "date-time")`
`65`	`66`	`.put(String.class, "string")`
`66`	`67`	`.put(Object.class, "object")`
`67`	`68`	`.put(Long.class, "long")`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,8 @@ class SimpleTypeSpec extends SchemaSpecification {`
`88`	`88`	`"anObjectDouble" \| Double \| "java.lang.Double"`
`89`	`89`	`"currency" \| Currency\| "java.util.Currency"`
`90`	`90`	`"uuid" \| UUID \| "java.util.UUID"`
	`91`	`+ "aDate" \| Date \| "java.util.Date"`
	`92`	`+ "aSqlDate" \| java.sql.Date \| "java.sql.Date"`
`91`	`93`	`}`
`92`	`94`
`93`	`95`	`@Ignore`