Improve support of HttpEntity. fixes #280

Author: springdoc

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

@@ -13,6 +13,7 @@
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -226,7 +227,7 @@ private Schema<?> calculateSchema(Components components, Type returnType, JsonVi
         }
         if (returnType instanceof ParameterizedType) {
             schemaN = calculateSchemaFromParameterizedType(components, (ParameterizedType) returnType, jsonView);
-        } else if (ResponseEntity.class.getName().equals(returnType.getTypeName())) {
+        } else if (ResponseEntity.class.getName().equals(returnType.getTypeName()) || HttpEntity.class.getName().equals(returnType.getTypeName())) {
             schemaN = AnnotationsUtils.resolveSchemaFromType(String.class, null, jsonView);
         }
         if (schemaN == null) {

springdoc-openapi-webflux-core/src/main/java/org/springdoc/core/ResponseBuilder.java

@@ -4,6 +4,7 @@
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Schema;
+import org.springframework.http.HttpEntity;
 import org.springframework.http.ResponseEntity;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -41,7 +42,7 @@ protected Schema calculateSchemaFromParameterizedType(Components components, Par
             } else {
                 schemaN = calculateFluxSchema(components, parameterizedType, jsonView);
             }
-        } else if (ResponseEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
+        } else if (ResponseEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName()) || HttpEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
             schemaN = calculateSchemaParameterizedType(components, parameterizedType, jsonView);
         }
         return schemaN;

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/core/ResponseBuilder.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.media.Schema;
+import org.springframework.http.HttpEntity;
 import org.springframework.http.ResponseEntity;
 
 import java.lang.reflect.ParameterizedType;
@@ -18,7 +19,7 @@ public ResponseBuilder(OperationBuilder operationBuilder) {
     protected Schema calculateSchemaFromParameterizedType(Components components, ParameterizedType parameterizedType,
                                                           JsonView jsonView) {
         Schema<?> schemaN = null;
-        if (ResponseEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
+        if (ResponseEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName()) || HttpEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
             schemaN = calculateSchemaParameterizedType(components, parameterizedType, jsonView);
         }
         return schemaN;

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

@@ -1,5 +1,6 @@
 package test.org.springdoc.api.app14;
 
+import org.springframework.http.HttpEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -9,9 +10,13 @@
 @RestController
 public class HelloController {
 
-    @GetMapping(value = "/persons")
+    @GetMapping( "/persons")
     public void persons(@Valid @NotBlank String name) {
 
     }
 
+    @GetMapping("/test")
+    public HttpEntity<String> demo2() {
+        return null;
+    }
 }

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

@@ -11,6 +11,26 @@
     }
   ],
   "paths": {
+    "/test": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "demo2",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/persons": {
       "get": {
         "tags": [