handle request body

Author: hauner

src/main/groovy/com/github/hauner/openapi/spring/converter/ApiConverter.groovy

@@ -18,6 +18,7 @@ package com.github.hauner.openapi.spring.converter
 
 import com.github.hauner.openapi.spring.model.Api
 import com.github.hauner.openapi.spring.model.Endpoint
+import com.github.hauner.openapi.spring.model.RequestBody
 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.Parameter as ModelParameter
@@ -88,6 +89,26 @@ class ApiConverter {
                         ep.parameters.addAll (createParameter(parameter, target, resolver))
                     }
 
+                    if (httpOperation.requestBody != null) {
+                        def required = httpOperation.requestBody.required != null ?: false
+                        httpOperation.requestBody.content.each { Map.Entry<String, MediaType> requestBodyEntry ->
+                            def contentType = requestBodyEntry.key
+                            def requestBody = requestBodyEntry.value
+
+                            def info = new SchemaInfo (requestBody.schema, getInlineTypeName (path))
+                            info.resolver = resolver
+
+                            DataType dataType = dataTypeConverter.convert (info, target.models)
+
+                            def body = new RequestBody(
+                                contentType: contentType,
+                                requestBodyType: dataType,
+                                required: required)
+
+                            ep.requestBodies.add (body)
+                        }
+                    }
+
                     httpOperation.responses.each { Map.Entry<String, ApiResponse> responseEntry ->
                         def httpStatus = responseEntry.key
                         def httpResponse = responseEntry.value
@@ -136,6 +157,10 @@ class ApiConverter {
         }
     }
 
+    private String getInlineTypeName (String path) {
+        StringUtil.toCamelCase (path.substring (1)) + 'RequestBody'
+    }
+
     private String getInlineResponseName (String path, String httpStatus) {
         StringUtil.toCamelCase (path.substring (1)) + 'Response' + httpStatus
     }
@@ -189,4 +214,5 @@ class ApiConverter {
     private boolean hasTags (op) {
         op.tags && !op.tags.empty
     }
+
 }

src/main/groovy/com/github/hauner/openapi/spring/model/Endpoint.groovy

@@ -27,8 +27,13 @@ class Endpoint {
     String path
     HttpMethod method
 
-    List<Response> responses = []
     List<Parameter> parameters = []
+    List<RequestBody> requestBodies = []
+    List<Response> responses = []
+
+    RequestBody getRequestBody () {
+        requestBodies.first ()
+    }
 
     Response getResponse () {
         responses.first ()

src/main/groovy/com/github/hauner/openapi/spring/model/RequestBody.groovy

@@ -0,0 +1,48 @@
+/*
+ * 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
+
+import com.github.hauner.openapi.spring.model.datatypes.DataType
+
+/**
+ * Endpoint request body properties.
+ *
+ * @author Martin Hauner
+ */
+class RequestBody {
+
+    String contentType
+    DataType requestBodyType
+    boolean required
+
+    Set<String> getImports () {
+        requestBodyType.imports
+    }
+
+    String getAnnotationName () {
+        "RequestBody"
+    }
+
+    String getAnnotationWithPackage () {
+        "org.springframework.web.bind.annotation.${annotationName}"
+    }
+
+    String getAnnotation () {
+        "@${annotationName}"
+    }
+
+}

src/test/groovy/com/github/hauner/openapi/spring/converter/ApiConverterRequestBodySpec.groovy

@@ -0,0 +1,66 @@
+/*
+ * 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.converter
+
+import spock.lang.Specification
+
+import static com.github.hauner.openapi.spring.support.OpenApiParser.parse
+
+class ApiConverterRequestBodySpec extends Specification {
+
+    void "converts request body parameter"() {
+        def openApi = parse (
+"""\
+openapi: 3.0.2
+info:
+  title: test request body parameter
+  version: 1.0.0
+
+paths:
+  /endpoint:
+
+    get:
+      tags:
+        - endpoint
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                foo:
+                  type: string
+      responses:
+        '204':
+          description: empty
+""")
+
+        when:
+        def api = new ApiConverter ().convert (openApi)
+
+        then:
+        def itf = api.interfaces.first ()
+        def ep = itf.endpoints.first ()
+        def body = ep.requestBodies.first ()
+        body.contentType == 'application/json'
+        body.requestBodyType.type == 'EndpointRequestBody'
+        !body.required
+        body.annotation == '@RequestBody'
+        body.annotationWithPackage == 'org.springframework.web.bind.annotation.RequestBody'
+    }
+
+}