write parameter default value

Author: hauner

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/DataTypeConstraints.groovy

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 the original 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 com.github.hauner.openapi.spring.model.datatypes
+
+/**
+ * OpenAPI constraint details of a data type.
+ */
+interface DataTypeConstraints<T> {
+
+    T getDefault()
+
+}

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/StringDataType.groovy

@@ -23,6 +23,8 @@ package com.github.hauner.openapi.spring.model.datatypes
  */
 class StringDataType implements DataType {
 
+    StringDataTypeConstraints constraints
+
     @Override
     String getName () {
         'String'
@@ -43,4 +45,9 @@ class StringDataType implements DataType {
         []
     }
 
+    @Override
+    DataTypeConstraints<String> getConstraints() {
+        constraints
+    }
+
 }

src/main/groovy/com/github/hauner/openapi/spring/model/datatypes/StringDataTypeConstraints.groovy

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 the original 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 com.github.hauner.openapi.spring.model.datatypes;
+
+/**
+ * OpenAPI constraints of {@link StringDataType}.
+ *
+ * @author Martin Hauner
+ */
+class StringDataTypeConstraints implements DataTypeConstraints<String> {
+
+    def dfault
+
+    @Override
+    String getDefault () {
+        dfault
+    }
+
+}

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/CookieParameter.groovy

@@ -53,6 +53,10 @@ class CookieParameter implements Parameter {
         required
     }
 
+    ParameterConstraints getConstraints() {
+        null
+    }
+
     /**
      * Create annotation?
      */

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/HeaderParameter.groovy

@@ -53,6 +53,10 @@ class HeaderParameter implements Parameter {
         required
     }
 
+    ParameterConstraints getConstraints() {
+        null
+    }
+
     /**
      * Create annotation?
      */

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/ParameterConstraints.groovy

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 the original 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 com.github.hauner.openapi.spring.model.parameters
+
+import com.github.hauner.openapi.spring.model.datatypes.DataTypeConstraints
+
+/**
+ * Constraints of the parameter data type.
+ *
+ * @author Martin Hauner
+ */
+class ParameterConstraints {
+
+    DataTypeConstraints constraints
+
+    boolean hasDefault() {
+        constraints != null
+    }
+
+    def getDefault() {
+        constraints.default
+    }
+
+}

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/PathParameter.groovy

@@ -53,6 +53,10 @@ class PathParameter implements Parameter {
         required
     }
 
+    ParameterConstraints getConstraints() {
+        null
+    }
+
     /**
      * Create annotation?
      */

src/main/groovy/com/github/hauner/openapi/spring/model/parameters/QueryParameter.groovy

@@ -60,6 +60,10 @@ class QueryParameter implements Parameter {
         required
     }
 
+    ParameterConstraints getConstraints() {
+        new ParameterConstraints(constraints: dataType.constraints)
+    }
+
     /**
      * Create annotation? If the query parameter is mapped to a pojo object it should not have a
      * {@code @RequestParam} annotation.

src/main/groovy/com/github/hauner/openapi/spring/writer/MethodWriter.groovy

@@ -70,6 +70,11 @@ class MethodWriter {
             param += 'required = false'
         }
 
+        if (!parameter.required && parameter.constraints?.hasDefault()) {
+            param += ", "
+            param += "default = ${getDefault(parameter)}"
+        }
+
         param += ')'
         param
     }
@@ -116,4 +121,13 @@ class MethodWriter {
         '"' + content + '"'
     }
 
+    private def getDefault(Parameter parameter) {
+        def value = parameter.constraints.default
+        if (value instanceof String) {
+            quote(value)
+        } else {
+            value
+        }
+    }
+
 }

src/test/groovy/com/github/hauner/openapi/spring/writer/MethodWriterSpec.groovy

@@ -33,6 +33,7 @@ import com.github.hauner.openapi.spring.model.datatypes.NoneDataType
 import com.github.hauner.openapi.spring.model.datatypes.ObjectDataType
 import com.github.hauner.openapi.spring.model.datatypes.SetDataType
 import com.github.hauner.openapi.spring.model.datatypes.StringDataType
+import com.github.hauner.openapi.spring.model.datatypes.StringDataTypeConstraints
 import com.github.hauner.openapi.spring.model.parameters.CookieParameter
 import com.github.hauner.openapi.spring.model.parameters.HeaderParameter
 import com.github.hauner.openapi.spring.model.parameters.QueryParameter
@@ -366,4 +367,23 @@ class MethodWriterSpec extends Specification {
 """
     }
 
+    void "writes simple (optional) parameter with default value" () {
+        def endpoint = new Endpoint (path: '/foo', method: HttpMethod.GET, responses: [
+            new Response (contentType: 'application/json', responseType: new NoneDataType())
+        ], parameters: [
+            new QueryParameter(name: 'foo', required: false,
+                dataType: new StringDataType(
+                    constraints: new StringDataTypeConstraints (dfault: 'bar')))
+        ])
+
+        when:
+        writer.write (target, endpoint)
+
+        then:
+        target.toString () == """\
+    @GetMapping(path = "${endpoint.path}")
+    ResponseEntity<void> getFoo(@RequestParam(name = "foo", required = false, default = "bar") String foo);
+"""
+    }
+
 }