#13 - OpenAPI requestBody for @Form or form parameters

Author: rbygrave

src/main/java/io/dinject/javalin/generator/ElementReader.java

@@ -9,6 +9,7 @@
 import io.dinject.controller.QueryParam;
 import io.dinject.javalin.generator.javadoc.Javadoc;
 import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 
 import javax.lang.model.element.Element;
@@ -147,17 +148,36 @@ void writeParamName(Append writer) {
 
   void addMeta(ProcessingContext ctx, Javadoc javadoc, Operation operation) {
     if (!isJavalinContext()) {
+      if (paramType == ParamType.FORM || paramType == ParamType.BODY) {
+        addMetaRequestBody(ctx, javadoc, operation);
 
-      Parameter param = new Parameter();
-      param.setName(varName);
-      param.setDescription(javadoc.getParams().get(paramName));
-      param.setIn(paramType.getType());
-      param.setSchema(ctx.toSchema(rawType, element));
-
-      operation.addParametersItem(param);
+      } else {
+        Parameter param = new Parameter();
+        param.setName(varName);
+        param.setDescription(javadoc.getParams().get(paramName));
+
+        Schema schema = ctx.toSchema(rawType, element);
+        if (paramType == ParamType.FORMPARAM) {
+          ctx.addFormParam(operation, varName, schema);
+
+        } else {
+          param.setSchema(schema);
+          param.setIn(paramType.getType());
+          operation.addParametersItem(param);
+        }
+      }
     }
   }
 
+  private void addMetaRequestBody(ProcessingContext ctx, Javadoc javadoc, Operation operation) {
+
+    Schema schema = ctx.toSchema(rawType, element);
+    String description = javadoc.getParams().get(paramName);
+
+    boolean asForm = (paramType == ParamType.FORM);
+    ctx.addRequestBody(operation, schema, asForm, description);
+  }
+
   void writeCtxGet(Append writer, PathSegments segments) {
 
     if (isJavalinContext()) {

src/main/java/io/dinject/javalin/generator/ProcessingContext.java

@@ -2,6 +2,7 @@
 
 import io.dinject.javalin.generator.openapi.SchemaBuilder;
 import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.Paths;
 import io.swagger.v3.oas.models.media.Content;
@@ -141,4 +142,12 @@ TypeMirror asMemberOf(DeclaredType declaredType, Element element) {
   PathItem pathItem(String fullPath) {
     return pathMap.computeIfAbsent(fullPath, s -> new PathItem());
   }
+
+  void addFormParam(Operation operation, String varName, Schema schema) {
+    schemaBuilder.addFormParam(operation, varName, schema);
+  }
+
+  void addRequestBody(Operation operation, Schema schema, boolean asForm, String description) {
+    schemaBuilder.addRequestBody(operation, schema, asForm, description);
+  }
 }

src/main/java/io/dinject/javalin/generator/openapi/SchemaBuilder.java

@@ -3,12 +3,14 @@
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.MapSchema;
 import io.swagger.v3.oas.models.media.MediaType;
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.parameters.RequestBody;
 
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.Element;
@@ -33,6 +35,9 @@
  */
 public class SchemaBuilder {
 
+  private static final String APP_FORM = "application/x-www-form-urlencoded";
+  private static final String APP_JSON = "application/json";
+
   private final Types types;
   private final KnownTypes knownTypes;
   private final TypeMirror iterableType;
@@ -59,6 +64,61 @@ public Content createContent(TypeMirror returnType, String mediaType) {
     return content;
   }
 
+  /**
+   * Add parameter as a form parameter.
+   */
+  public void addFormParam(Operation operation, String varName, Schema schema) {
+    RequestBody body = requestBody(operation);
+    Schema formSchema = requestFormParamSchema(body);
+    formSchema.addProperties(varName, schema);
+  }
+
+  private Schema requestFormParamSchema(RequestBody body) {
+
+    final Content content = body.getContent();
+    MediaType mediaType = content.get(APP_FORM);
+
+    Schema schema;
+    if (mediaType != null) {
+      schema = mediaType.getSchema();
+    } else {
+      schema = new Schema();
+      schema.setType("object");
+      mediaType = new MediaType();
+      mediaType.schema(schema);
+      content.addMediaType(APP_FORM, mediaType);
+    }
+    return schema;
+  }
+
+  /**
+   * Add as request body.
+   */
+  public void addRequestBody(Operation operation, Schema schema, boolean asForm, String description) {
+
+    RequestBody body = requestBody(operation);
+    body.setDescription(description);
+
+    MediaType mt = new MediaType();
+    mt.schema(schema);
+
+    String mime = asForm ? APP_FORM : APP_JSON;
+    body.getContent().addMediaType(mime, mt);
+  }
+
+  private RequestBody requestBody(Operation operation) {
+
+    RequestBody body = operation.getRequestBody();
+    if (body == null) {
+      body = new RequestBody();
+      body.setRequired(true);
+      Content content = new Content();
+      body.setContent(content);
+      operation.setRequestBody(body);
+    }
+    return body;
+  }
+
   public Schema<?> toSchema(TypeMirror type) {
 
     Schema<?> schema = knownTypes.createSchema(type.toString());