Add BodyString annotation, to support controllers with body of type String (#198)

* Body String

* professionals have standards

* fix bodyPublisher

* rename to body

* import

* Update Body.java

* Revert "rename to body"

* fix other body types

* input stream body

* Update BodyString.java

* Update ElementReader.java

* now will use application/text fo  string

Author: SentryMan

http-api/src/main/java/io/avaje/http/api/BodyString.java

@@ -0,0 +1,15 @@
+package io.avaje.http.api;
+
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a controller string method parameter to be a string body. Use when you expect to receive an
+ * application/text or similar body request.
+ */
+@Retention(SOURCE)
+@Target(PARAMETER)
+public @interface BodyString {}

http-generator-core/src/main/java/io/avaje/http/generator/core/ElementReader.java

@@ -38,7 +38,6 @@ public class ElementReader {
   private boolean isParamCollection;
   private boolean isParamMap;
   private final Set<String> imports = new HashSet<>();
-  // private boolean notNullJavax;
 
   ElementReader(Element element, ParamType defaultType, boolean formMarker) {
     this(element, null, Util.typeDef(element.asType()), defaultType, formMarker);
@@ -140,13 +139,11 @@ private void readAnnotations(Element element, ParamType defaultType) {
     if (defaultVal != null) {
       this.paramDefault = defaultVal.value();
     }
-    final var form = FormPrism.getInstanceOn(element);
-    if (form != null) {
+    if (FormPrism.isPresent(element)) {
       this.paramType = ParamType.FORM;
       return;
     }
-    final var beanParam = BeanParamPrism.getInstanceOn(element);
-    if (beanParam != null) {
+    if (BeanParamPrism.isPresent(element)) {
       this.paramType = ParamType.BEANPARAM;
       return;
     }
@@ -185,6 +182,12 @@ private void readAnnotations(Element element, ParamType defaultType) {
       return;
     }
 
+    if ("java.lang.String".equals(element.asType().toString())
+        && BodyStringPrism.isPresent(element)) {
+      this.paramType = ParamType.BODY;
+      return;
+    }
+
     if (paramType == null) {
       this.impliedParamType = true;
       if (typeHandler != null) {
@@ -249,22 +252,14 @@ void writeParamName(Append writer) {
    * Build the OpenAPI documentation for this parameter.
    */
   void buildApiDocumentation(MethodDocBuilder methodDoc) {
-    if (!isPlatformContext() && !isParamMap && paramType != ParamType.BEANPARAM) {
-      if (includeParam()) {
-        new MethodParamDocBuilder(methodDoc, this).build();
-      }
+    if (!isPlatformContext()
+        && !isParamMap
+        && paramType != ParamType.BEANPARAM
+        && !IgnorePrism.isPresent(element)) {
+      new MethodParamDocBuilder(methodDoc, this).build();
     }
   }
 
-  private boolean includeParam() {
-    for (AnnotationMirror annotationMirror : element.getAnnotationMirrors()) {
-      if ("io.avaje.http.api.Ignore".equals(annotationMirror.getAnnotationType().toString())) {
-        return false;
-      }
-    }
-    return true;
-  }
-
   void writeValidate(Append writer) {
     if (!contextType && typeHandler == null) {
       if (useValidation) {
@@ -338,7 +333,7 @@ private boolean setValue(Append writer, PathSegments segments, String shortType)
       writer.append(asMethod);
     }
 
-    if (typeHandler == null) {
+    if (typeHandler == null || paramType == ParamType.BODY) {
       // this is a body (POST, PATCH)
       writer.append(platform().bodyAsClass(type));
 

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/SchemaDocBuilder.java

@@ -45,6 +45,7 @@ class SchemaDocBuilder {
 
   private static final String APP_FORM = "application/x-www-form-urlencoded";
   private static final String APP_JSON = "application/json";
+  private static final String APP_TXT = "application/text";
 
   private final Elements elements;
   private final Types types;
@@ -113,6 +114,9 @@ void addRequestBody(Operation operation, Schema schema, boolean asForm, String d
     mt.schema(schema);
 
     String mime = asForm ? APP_FORM : APP_JSON;
+    if (schema instanceof StringSchema) {
+      mime = APP_TXT;
+    }
     body.getContent().addMediaType(mime, mt);
   }
 

http-generator-core/src/main/java/io/avaje/http/generator/core/package-info.java

@@ -5,6 +5,7 @@
 @GeneratePrism(value = io.avaje.http.api.QueryParam.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Client.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Cookie.class, publicAccess = true)
+@GeneratePrism(value = io.avaje.http.api.BodyString.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Default.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Delete.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Form.class, publicAccess = true)

http-generator-javalin/src/main/java/io/avaje/http/generator/javalin/JavalinAdapter.java

@@ -1,9 +1,13 @@
 package io.avaje.http.generator.javalin;
 
-import io.avaje.http.generator.core.*;
-
 import java.util.List;
 
+import io.avaje.http.generator.core.Append;
+import io.avaje.http.generator.core.ControllerReader;
+import io.avaje.http.generator.core.ParamType;
+import io.avaje.http.generator.core.PlatformAdapter;
+import io.avaje.http.generator.core.UType;
+
 class JavalinAdapter implements PlatformAdapter {
 
   static final String JAVALIN3_CONTEXT = "io.javalin.http.Context";
@@ -31,9 +35,11 @@ public boolean isBodyMethodParam() {
 
   @Override
   public String bodyAsClass(UType type) {
-    if (type.full().startsWith("java.io.InputStream")) {
+    if ("java.io.InputStream".equals(type.full())) {
       return "ctx.bodyInputStream()";
-    } else if (type.full().startsWith("byte[]")) {
+    } else if ("java.lang.String".equals(type.full())) {
+      return "ctx.body()";
+    } else if ("byte[]".equals(type.full())) {
       return "ctx.bodyAsBytes()";
     } else {
       if (useJsonB) {

http-generator-jex/src/main/java/io/avaje/http/generator/jex/JexAdapter.java

@@ -29,6 +29,9 @@ public boolean isBodyMethodParam() {
 
   @Override
   public String bodyAsClass(UType uType) {
+    if ("java.lang.String".equals(uType.full())) {
+      return "ctx.body()";
+    }
     return "ctx.bodyAsClass(" + uType.mainType() + ".class)";
   }
 

tests/test-helidon/src/main/java/org/example/TestController.java

@@ -4,6 +4,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import io.avaje.http.api.BodyString;
 import io.avaje.http.api.Controller;
 import io.avaje.http.api.Cookie;
 import io.avaje.http.api.Default;
@@ -40,4 +41,9 @@ String enumQueryImplied(String s, @QueryParam ServerType type) {
   String mapTest(Map<String, List<String>> strings, @Cookie Map<String, List<String>> cookie) {
     return strings.toString();
   }
+
+  @Post("/strBody")
+  String strBody(@BodyString String body) {
+    return body;
+  }
 }

tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/test/TestController2.java

@@ -6,6 +6,7 @@
 
 import org.example.myapp.web.ServerType;
 
+import io.avaje.http.api.BodyString;
 import io.avaje.http.api.Controller;
 import io.avaje.http.api.Default;
 import io.avaje.http.api.Form;
@@ -54,4 +55,9 @@ String stream(InputStream stream) {
   String bytes(byte[] array) {
     return array.toString();
   }
+
+  @Post("/strBody")
+  String strBody(@BodyString String body) {
+    return body;
+  }
 }

tests/test-jex/src/main/java/org/example/web/TestController.java

@@ -2,12 +2,14 @@
 
 import java.util.Set;
 
+import io.avaje.http.api.BodyString;
 import io.avaje.http.api.Controller;
 import io.avaje.http.api.Default;
 import io.avaje.http.api.Get;
 import io.avaje.http.api.Path;
 import io.avaje.http.api.Post;
 import io.avaje.http.api.QueryParam;
+import io.avaje.jex.Context;
 
 @Path("test/")
 @Controller
@@ -33,4 +35,8 @@ String enumQueryImplied(String s, @QueryParam ServerType type) {
     return type.name();
   }
 
+  @Post("/strBody")
+  String strBody(@BodyString String body, Context ctx) {
+    return body;
+  }
 }

tests/test-nima-jsonb/src/main/java/org/example/TestController.java

@@ -4,6 +4,7 @@
 import java.util.List;
 import java.util.Set;
 
+import io.avaje.http.api.BodyString;
 import io.avaje.http.api.Controller;
 import io.avaje.http.api.Default;
 import io.avaje.http.api.Form;
@@ -57,4 +58,9 @@ String enumQueryImplied(String s, @QueryParam ServerType type) {
   String stream(InputStream stream) {
     return stream.toString();
   }
+
+  @Post("/strBody")
+  String strBody(@BodyString String body) {
+    return body;
+  }
 }