Added support: Example value can be specified without having to specify a schema. Fixes #352

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java

@@ -13,7 +13,6 @@
 import java.util.Map;
 import java.util.Optional;
 
-@SuppressWarnings("rawtypes")
 public class RequestBodyBuilder {
 
     private final AbstractParameterBuilder parameterBuilder;
@@ -109,35 +108,39 @@ private RequestBody buildRequestBody(RequestBody requestBody, Components compone
             requestBody.setRequired(parameter.getRequired());
         }
 
-        if (requestBody.getContent() == null
-                || (requestBody.getContent() != null && methodAttributes.isMethodOverloaded())) {
+        if (requestBody.getContent() == null) {
             Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo.getParameter(),
                     parameterInfo.getpName(), requestBodyInfo,
                     methodAttributes.getJsonViewAnnotationForRequestBody());
             buildContent(requestBody, methodAttributes, schema);
+        } else if (requestBody.getContent() != null && (methodAttributes.isMethodOverloaded() ||
+                requestBody.getContent().values().stream().anyMatch(mediaType -> mediaType.getSchema() == null))) {
+            Schema<?> schema = parameterBuilder.calculateSchema(components, parameterInfo.getParameter(),
+                    parameterInfo.getpName(), requestBodyInfo,
+                    methodAttributes.getJsonViewAnnotationForRequestBody());
+            mergeContent(requestBody, methodAttributes, schema);
         }
         return requestBody;
     }
 
-    private void buildContent(RequestBody requestBody, MethodAttributes methodAttributes, Schema<?> schema) {
+    private void mergeContent(RequestBody requestBody, MethodAttributes methodAttributes, Schema<?> schema) {
         Content content = requestBody.getContent();
-        if (methodAttributes.isMethodOverloaded() && content != null) {
-            for (String value : methodAttributes.getAllConsumes()) {
-                setMediaTypeToContent(schema, content, value);
-            }
-        } else {
-            content = new Content();
-            for (String value : methodAttributes.getAllConsumes()) {
-                setMediaTypeToContent(schema, content, value);
-            }
-        }
-        requestBody.setContent(content);
+        buildContent(requestBody, methodAttributes, schema, content);
     }
 
+    private void buildContent(RequestBody requestBody, MethodAttributes methodAttributes, Schema<?> schema) {
+        Content content = new Content();
+        buildContent(requestBody, methodAttributes, schema, content);
+    }
 
-    private void setMediaTypeToContent(Schema schema, Content content, String value) {
-        io.swagger.v3.oas.models.media.MediaType mediaTypeObject = new io.swagger.v3.oas.models.media.MediaType();
-        mediaTypeObject.setSchema(schema);
-        content.addMediaType(value, mediaTypeObject);
+    private void buildContent(RequestBody requestBody, MethodAttributes methodAttributes, Schema<?> schema, Content content) {
+        for (String value : methodAttributes.getAllConsumes()) {
+            io.swagger.v3.oas.models.media.MediaType mediaTypeObject = new io.swagger.v3.oas.models.media.MediaType();
+            mediaTypeObject.setSchema(schema);
+            if (content.get(value) != null)
+                mediaTypeObject.setExample(content.get(value).getExample());
+            content.addMediaType(value, mediaTypeObject);
+        }
+        requestBody.setContent(content);
     }
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app74/HelloController.java

@@ -0,0 +1,28 @@
+package test.org.springdoc.api.app74;
+
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.*;
+
+
+@RestController
+public class HelloController {
+
+    @PostMapping("/test")
+    @RequestBody(
+            content = @Content(
+                    examples = @ExampleObject(
+                            value = "sample"
+                    )
+            )
+    )
+    public String postMyRequestBody(
+            String myRequestBody) {
+        return null;
+    }
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app74/SpringDocApp74Test.java

@@ -0,0 +1,10 @@
+package test.org.springdoc.api.app74;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp74Test extends AbstractSpringDocTest {
+
+    @SpringBootApplication
+    static class SpringDocTestApp { }
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app74.json

@@ -0,0 +1,46 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "post": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "postMyRequestBody",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string"
+              },
+              "example": "sample"
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}