locale as param (#185)

Author: jmisur

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/util/TypeUtil.java

@@ -61,6 +61,15 @@ private static String getSimpleName(String canonicalName) {
             return "String";
         case "java.lang.Boolean":
             return "Boolean";
+        default:
+            return getSpecialTypeName(canonicalName);
+        }
+    }
+
+    private static String getSpecialTypeName(String canonicalName) {
+        switch (canonicalName) {
+        case "java.util.Locale":
+            return "String";
         default:
             return "Object";
         }

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/request/RequestParametersSnippetTest.java

@@ -23,6 +23,8 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
+import java.util.Locale;
+
 import capital.scalable.restdocs.constraints.ConstraintReader;
 import capital.scalable.restdocs.javadoc.JavadocReader;
 import org.junit.Before;
@@ -140,6 +142,23 @@ public void simpleRequestWithStringDefaultValueParameter() throws Exception {
                 .build());
     }
 
+    @Test
+    public void simpleRequestWithCustomTypes() throws Exception {
+        HandlerMethod handlerMethod = createHandlerMethod("searchItem5", Locale.class);
+        initParameters(handlerMethod);
+        mockParamComment("searchItem5", "locale", "A locale");
+
+        this.snippets.expect(REQUEST_PARAMETERS).withContents(
+                tableWithHeader("Parameter", "Type", "Optional", "Description")
+                        .row("locale", "String", "false", "A locale."));
+
+        new RequestParametersSnippet().document(operationBuilder
+                .attribute(HandlerMethod.class.getName(), handlerMethod)
+                .attribute(JavadocReader.class.getName(), javadocReader)
+                .attribute(ConstraintReader.class.getName(), constraintReader)
+                .build());
+    }
+
     @Test
     public void noParameters() throws Exception {
         HandlerMethod handlerMethod = createHandlerMethod("items");
@@ -279,6 +298,10 @@ public void searchItem4(@RequestParam int text, Pageable page) {
             // NOOP
         }
 
+        public void searchItem5(@RequestParam Locale locale) {
+            // NOOP
+        }
+
         public void removeItem(@Deprecated @RequestParam int index) {
             // NOOP
         }